Search is not available for this dataset
identifier
stringlengths
1
155
parameters
stringlengths
2
6.09k
docstring
stringlengths
11
63.4k
docstring_summary
stringlengths
0
63.4k
function
stringlengths
29
99.8k
function_tokens
list
start_point
list
end_point
list
language
stringclasses
1 value
docstring_language
stringlengths
2
7
docstring_language_predictions
stringlengths
18
23
is_langid_reliable
stringclasses
2 values
Mob.at_hit
(self, weapon, attacker, damage)
Someone landed a hit on us. Check our status and start attacking if not already doing so.
Someone landed a hit on us. Check our status and start attacking if not already doing so.
def at_hit(self, weapon, attacker, damage): """ Someone landed a hit on us. Check our status and start attacking if not already doing so. """ if self.db.health is None: # health not set - this can't be damaged. attacker.msg(self.db.weapon_ineffective_msg) ...
[ "def", "at_hit", "(", "self", ",", "weapon", ",", "attacker", ",", "damage", ")", ":", "if", "self", ".", "db", ".", "health", "is", "None", ":", "# health not set - this can't be damaged.", "attacker", ".", "msg", "(", "self", ".", "db", ".", "weapon_inef...
[ 387, 4 ]
[ 414, 38 ]
python
en
['en', 'error', 'th']
False
Mob.at_new_arrival
(self, new_character)
This is triggered whenever a new character enters the room. This is called by the TutorialRoom the mob stands in and allows it to be aware of changes immediately without needing to poll for them all the time. For example, the mob can react right away, also when patrolling on a v...
This is triggered whenever a new character enters the room. This is called by the TutorialRoom the mob stands in and allows it to be aware of changes immediately without needing to poll for them all the time. For example, the mob can react right away, also when patrolling on a v...
def at_new_arrival(self, new_character): """ This is triggered whenever a new character enters the room. This is called by the TutorialRoom the mob stands in and allows it to be aware of changes immediately without needing to poll for them all the time. For example, the mob can r...
[ "def", "at_new_arrival", "(", "self", ",", "new_character", ")", ":", "# the room actually already checked all we need, so", "# we know it is a valid target.", "if", "self", ".", "db", ".", "aggressive", "and", "not", "self", ".", "ndb", ".", "is_attacking", ":", "sel...
[ 416, 4 ]
[ 427, 34 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 a...
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 a...
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 wheth...
[ "def", "autocolorscale", "(", "self", ")", ":", "return", "self", "[", "\"autocolorscale\"", "]" ]
[ 61, 4 ]
[ 77, 37 ]
python
en
['en', 'error', 'th']
False
Choropleth.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...
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...
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 t...
[ "def", "coloraxis", "(", "self", ")", ":", "return", "self", "[", "\"coloraxis\"", "]" ]
[ 86, 4 ]
[ 104, 32 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 Supported dict properties: ...
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 Supported dict properties: ...
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 ...
[ "def", "colorbar", "(", "self", ")", ":", "return", "self", "[", "\"colorbar\"", "]" ]
[ 113, 4 ]
[ 339, 31 ]
python
en
['en', 'error', 'th']
False
Choropleth.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...
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...
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, `[...
[ "def", "colorscale", "(", "self", ")", ":", "return", "self", "[", "\"colorscale\"", "]" ]
[ 348, 4 ]
[ 391, 33 ]
python
en
['en', 'error', 'th']
False
Choropleth.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,...
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,...
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 sp...
[ "def", "customdata", "(", "self", ")", ":", "return", "self", "[", "\"customdata\"", "]" ]
[ 400, 4 ]
[ 414, 33 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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["cust...
[ "def", "customdatasrc", "(", "self", ")", ":", "return", "self", "[", "\"customdatasrc\"", "]" ]
[ 423, 4 ]
[ 435, 36 ]
python
en
['en', 'error', 'th']
False
Choropleth.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: ...
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: ...
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 s...
[ "def", "featureidkey", "(", "self", ")", ":", "return", "self", "[", "\"featureidkey\"", "]" ]
[ 444, 4 ]
[ 459, 35 ]
python
en
['en', 'error', 'th']
False
Choropleth.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...
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...
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' pr...
[ "def", "geo", "(", "self", ")", ":", "return", "self", "[", "\"geo\"", "]" ]
[ 468, 4 ]
[ 484, 26 ]
python
en
['en', 'error', 'th']
False
Choropleth.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...
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...
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 g...
[ "def", "geojson", "(", "self", ")", ":", "return", "self", "[", "\"geojson\"", "]" ]
[ 493, 4 ]
[ 507, 30 ]
python
en
['en', 'error', 'th']
False
Choropleth.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: ...
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: ...
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 ...
[ "def", "hoverinfo", "(", "self", ")", ":", "return", "self", "[", "\"hoverinfo\"", "]" ]
[ 516, 4 ]
[ 533, 32 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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["hoverin...
[ "def", "hoverinfosrc", "(", "self", ")", ":", "return", "self", "[", "\"hoverinfosrc\"", "]" ]
[ 542, 4 ]
[ 554, 35 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 Supported dict proper...
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 Supported dict proper...
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 ...
[ "def", "hoverlabel", "(", "self", ")", ":", "return", "self", "[", "\"hoverlabel\"", "]" ]
[ 563, 4 ]
[ 613, 33 ]
python
en
['en', 'error', 'th']
False
Choropleth.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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$...
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}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$...
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}". Numbers are formatted using d3-format's syntax %{variable:d...
[ "def", "hovertemplate", "(", "self", ")", ":", "return", "self", "[", "\"hovertemplate\"", "]" ]
[ 622, 4 ]
[ 654, 36 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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 se...
[ "def", "hovertemplatesrc", "(", "self", ")", ":", "return", "self", "[", "\"hovertemplatesrc\"", "]" ]
[ 663, 4 ]
[ 675, 39 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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 ------- ...
[ "def", "hovertext", "(", "self", ")", ":", "return", "self", "[", "\"hovertext\"", "]" ]
[ 684, 4 ]
[ 697, 32 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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["hoverte...
[ "def", "hovertextsrc", "(", "self", ")", ":", "return", "self", "[", "\"hovertextsrc\"", "]" ]
[ 706, 4 ]
[ 718, 35 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 Retur...
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
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 pa...
[ "def", "ids", "(", "self", ")", ":", "return", "self", "[", "\"ids\"", "]" ]
[ 727, 4 ]
[ 740, 26 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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"]
[ "def", "idssrc", "(", "self", ")", ":", "return", "self", "[", "\"idssrc\"", "]" ]
[ 749, 4 ]
[ 760, 29 ]
python
en
['en', 'error', 'th']
False
Choropleth.legendgroup
(self)
Sets the legend group for this trace. Traces 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 R...
Sets the legend group for this trace. Traces 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
def legendgroup(self): """ Sets the legend group for this trace. Traces 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 b...
[ "def", "legendgroup", "(", "self", ")", ":", "return", "self", "[", "\"legendgroup\"", "]" ]
[ 769, 4 ]
[ 783, 34 ]
python
en
['en', 'error', 'th']
False
Choropleth.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` attribut...
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` attribut...
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 GeoJS...
[ "def", "locationmode", "(", "self", ")", ":", "return", "self", "[", "\"locationmode\"", "]" ]
[ 792, 4 ]
[ 808, 35 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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 ...
[ "def", "locations", "(", "self", ")", ":", "return", "self", "[", "\"locations\"", "]" ]
[ 817, 4 ]
[ 829, 32 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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["locatio...
[ "def", "locationssrc", "(", "self", ")", ":", "return", "self", "[", "\"locationssrc\"", "]" ]
[ 838, 4 ]
[ 850, 35 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 Supported dict properties: ...
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 Supported dict properties: ...
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 Supporte...
[ "def", "marker", "(", "self", ")", ":", "return", "self", "[", "\"marker\"", "]" ]
[ 859, 4 ]
[ 883, 29 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 acce...
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 acce...
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 ...
[ "def", "meta", "(", "self", ")", ":", "return", "self", "[", "\"meta\"", "]" ]
[ 892, 4 ]
[ 911, 27 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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"]
[ "def", "metasrc", "(", "self", ")", ":", "return", "self", "[", "\"metasrc\"", "]" ]
[ 920, 4 ]
[ 931, 30 ]
python
en
['en', 'error', 'th']
False
Choropleth.name
(self)
Sets the trace name. The trace name appear 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
Sets the trace name. The trace name appear 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
def name(self): """ Sets the trace name. The trace name appear 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 ...
[ "def", "name", "(", "self", ")", ":", "return", "self", "[", "\"name\"", "]" ]
[ 940, 4 ]
[ 953, 27 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 ...
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)
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) Retu...
[ "def", "reversescale", "(", "self", ")", ":", "return", "self", "[", "\"reversescale\"", "]" ]
[ 962, 4 ]
[ 975, 35 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 Supported dict properties: ...
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 Supported dict properties: ...
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 ...
[ "def", "selected", "(", "self", ")", ":", "return", "self", "[", "\"selected\"", "]" ]
[ 984, 4 ]
[ 1003, 31 ]
python
en
['en', 'error', 'th']
False
Choropleth.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...
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...
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 ...
[ "def", "selectedpoints", "(", "self", ")", ":", "return", "self", "[", "\"selectedpoints\"", "]" ]
[ 1012, 4 ]
[ 1027, 37 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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)
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["showle...
[ "def", "showlegend", "(", "self", ")", ":", "return", "self", "[", "\"showlegend\"", "]" ]
[ 1036, 4 ]
[ 1048, 33 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False)
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"]
[ "def", "showscale", "(", "self", ")", ":", "return", "self", "[", "\"showscale\"", "]" ]
[ 1057, 4 ]
[ 1069, 32 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 Supported dict properties: ...
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 Supported dict properties: ...
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 Supporte...
[ "def", "stream", "(", "self", ")", ":", "return", "self", "[", "\"stream\"", "]" ]
[ 1078, 4 ]
[ 1102, 29 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 ------- ...
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
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 Re...
[ "def", "text", "(", "self", ")", ":", "return", "self", "[", "\"text\"", "]" ]
[ 1111, 4 ]
[ 1124, 27 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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"]
[ "def", "textsrc", "(", "self", ")", ":", "return", "self", "[", "\"textsrc\"", "]" ]
[ 1133, 4 ]
[ 1144, 30 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 ------- ...
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
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 Return...
[ "def", "uid", "(", "self", ")", ":", "return", "self", "[", "\"uid\"", "]" ]
[ 1153, 4 ]
[ 1166, 26 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 co...
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 co...
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-driv...
[ "def", "uirevision", "(", "self", ")", ":", "return", "self", "[", "\"uirevision\"", "]" ]
[ 1175, 4 ]
[ 1199, 33 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 Supported dict proper...
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 Supported dict proper...
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 ...
[ "def", "unselected", "(", "self", ")", ":", "return", "self", "[", "\"unselected\"", "]" ]
[ 1208, 4 ]
[ 1227, 33 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 va...
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 va...
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 o...
[ "def", "visible", "(", "self", ")", ":", "return", "self", "[", "\"visible\"", "]" ]
[ 1236, 4 ]
[ 1250, 30 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
Sets the color values. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series
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"]
[ "def", "z", "(", "self", ")", ":", "return", "self", "[", "\"z\"", "]" ]
[ 1259, 4 ]
[ 1270, 24 ]
python
en
['en', 'error', 'th']
False
Choropleth.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,...
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,...
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 ...
[ "def", "zauto", "(", "self", ")", ":", "return", "self", "[", "\"zauto\"", "]" ]
[ 1279, 4 ]
[ 1293, 28 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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 ...
[ "def", "zmax", "(", "self", ")", ":", "return", "self", "[", "\"zmax\"", "]" ]
[ 1302, 4 ]
[ 1314, 27 ]
python
en
['en', 'error', 'th']
False
Choropleth.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 R...
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
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: -...
[ "def", "zmid", "(", "self", ")", ":", "return", "self", "[", "\"zmid\"", "]" ]
[ 1323, 4 ]
[ 1336, 27 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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 ...
[ "def", "zmin", "(", "self", ")", ":", "return", "self", "[", "\"zmin\"", "]" ]
[ 1345, 4 ]
[ 1357, 27 ]
python
en
['en', 'error', 'th']
False
Choropleth.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
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
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"]
[ "def", "zsrc", "(", "self", ")", ":", "return", "self", "[", "\"zsrc\"", "]" ]
[ 1366, 4 ]
[ 1377, 27 ]
python
en
['en', 'error', 'th']
False
Choropleth.__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, hoverl...
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 c...
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`.
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, ...
[ "def", "__init__", "(", "self", ",", "arg", "=", "None", ",", "autocolorscale", "=", "None", ",", "coloraxis", "=", "None", ",", "colorbar", "=", "None", ",", "colorscale", "=", "None", ",", "customdata", "=", "None", ",", "customdatasrc", "=", "None", ...
[ 1620, 4 ]
[ 2128, 34 ]
python
en
['en', 'error', 'th']
False
Annotation.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 <br> HTML tags) or if an explicit width is set to override the text width. The 'align' property is an enumeration that may be s...
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 <br> HTML tags) or if an explicit width is set to override the text width. The 'align' property is an enumeration that may be s...
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 <br> HTML tags) or if an explicit width is set to override the text width. The 'align' property is ...
[ "def", "align", "(", "self", ")", ":", "return", "self", "[", "\"align\"", "]" ]
[ 59, 4 ]
[ 74, 28 ]
python
en
['en', 'error', 'th']
False
Annotation.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,1...
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,1...
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%)') - ...
[ "def", "arrowcolor", "(", "self", ")", ":", "return", "self", "[", "\"arrowcolor\"", "]" ]
[ 83, 4 ]
[ 133, 33 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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]
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 """ ret...
[ "def", "arrowhead", "(", "self", ")", ":", "return", "self", "[", "\"arrowhead\"", "]" ]
[ 142, 4 ]
[ 154, 32 ]
python
en
['en', 'error', 'th']
False
Annotation.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') ...
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')
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 ...
[ "def", "arrowside", "(", "self", ")", ":", "return", "self", "[", "\"arrowside\"", "]" ]
[ 163, 4 ]
[ 177, 32 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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]
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...
[ "def", "arrowsize", "(", "self", ")", ":", "return", "self", "[", "\"arrowsize\"", "]" ]
[ 186, 4 ]
[ 199, 32 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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]
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"]
[ "def", "arrowwidth", "(", "self", ")", ":", "return", "self", "[", "\"arrowwidth\"", "]" ]
[ 208, 4 ]
[ 219, 33 ]
python
en
['en', 'error', 'th']
False
Annotation.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 an axis, this is an absolute value on that axis, like `x`, NOT a relative value...
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 an axis, this is an absolute value on that axis, like `x`, NOT a relative value...
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 an axis, this is an absolute value on that axis, like ...
[ "def", "ax", "(", "self", ")", ":", "return", "self", "[", "\"ax\"", "]" ]
[ 228, 4 ]
[ 242, 25 ]
python
en
['en', 'error', 'th']
False
Annotation.axref
(self)
Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ax` is a relative offset in pixels from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is specified in the same terms as that axis. This is useful for trendline annotations which should...
Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ax` is a relative offset in pixels from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is specified in the same terms as that axis. This is useful for trendline annotations which should...
def axref(self): """ Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ax` is a relative offset in pixels from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is specified in the same terms as that axis. This is useful for trendl...
[ "def", "axref", "(", "self", ")", ":", "return", "self", "[", "\"axref\"", "]" ]
[ 251, 4 ]
[ 270, 28 ]
python
en
['en', 'error', 'th']
False
Annotation.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 an axis, this is an absolute value on that axis, like `y`, NOT a relative value...
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 an axis, this is an absolute value on that axis, like `y`, NOT a relative value...
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 an axis, this is an absolute value on that axis, like ...
[ "def", "ay", "(", "self", ")", ":", "return", "self", "[", "\"ay\"", "]" ]
[ 279, 4 ]
[ 293, 25 ]
python
en
['en', 'error', 'th']
False
Annotation.ayref
(self)
Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ay` is a relative offset in pixels from `y`. If set to a y axis id (e.g. "y" or "y2"), `ay` is specified in the same terms as that axis. This is useful for trendline annotations which should ...
Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ay` is a relative offset in pixels from `y`. If set to a y axis id (e.g. "y" or "y2"), `ay` is specified in the same terms as that axis. This is useful for trendline annotations which should ...
def ayref(self): """ Indicates in what terms the tail of the annotation (ax,ay) is specified. If `pixel`, `ay` is a relative offset in pixels from `y`. If set to a y axis id (e.g. "y" or "y2"), `ay` is specified in the same terms as that axis. This is useful for trendli...
[ "def", "ayref", "(", "self", ")", ":", "return", "self", "[", "\"ayref\"", "]" ]
[ 302, 4 ]
[ 321, 28 ]
python
en
['en', 'error', 'th']
False
Annotation.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...
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...
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%)') - A...
[ "def", "bgcolor", "(", "self", ")", ":", "return", "self", "[", "\"bgcolor\"", "]" ]
[ 330, 4 ]
[ 380, 30 ]
python
en
['en', 'error', 'th']
False
Annotation.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/hsv...
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/hsv...
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,...
[ "def", "bordercolor", "(", "self", ")", ":", "return", "self", "[", "\"bordercolor\"", "]" ]
[ 389, 4 ]
[ 439, 34 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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]
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 """ re...
[ "def", "borderpad", "(", "self", ")", ":", "return", "self", "[", "\"borderpad\"", "]" ]
[ 448, 4 ]
[ 460, 32 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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]
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 """ ...
[ "def", "borderwidth", "(", "self", ")", ":", "return", "self", "[", "\"borderwidth\"", "]" ]
[ 469, 4 ]
[ 481, 34 ]
python
en
['en', 'error', 'th']
False
Annotation.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_...
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_...
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 pro...
[ "def", "captureevents", "(", "self", ")", ":", "return", "self", "[", "\"captureevents\"", "]" ]
[ 490, 4 ]
[ 506, 36 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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 ...
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 ...
[ "def", "clicktoshow", "(", "self", ")", ":", "return", "self", "[", "\"clicktoshow\"", "]" ]
[ 515, 4 ]
[ 538, 34 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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 ...
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 F...
[ "def", "font", "(", "self", ")", ":", "return", "self", "[", "\"font\"", "]" ]
[ 547, 4 ]
[ 584, 27 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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]
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 ----...
[ "def", "height", "(", "self", ")", ":", "return", "self", "[", "\"height\"", "]" ]
[ 593, 4 ]
[ 605, 29 ]
python
en
['en', 'error', 'th']
False
Annotation.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 Supported dict...
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 Supported dict...
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 constructo...
[ "def", "hoverlabel", "(", "self", ")", ":", "return", "self", "[", "\"hoverlabel\"", "]" ]
[ 614, 4 ]
[ 641, 33 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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
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 Retu...
[ "def", "hovertext", "(", "self", ")", ":", "return", "self", "[", "\"hovertext\"", "]" ]
[ 650, 4 ]
[ 663, 32 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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 ...
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` al...
[ "def", "name", "(", "self", ")", ":", "return", "self", "[", "\"name\"", "]" ]
[ 672, 4 ]
[ 690, 27 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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]
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"]
[ "def", "opacity", "(", "self", ")", ":", "return", "self", "[", "\"opacity\"", "]" ]
[ 699, 4 ]
[ 710, 30 ]
python
en
['en', 'error', 'th']
False
Annotation.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 -...
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)
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 F...
[ "def", "showarrow", "(", "self", ")", ":", "return", "self", "[", "\"showarrow\"", "]" ]
[ 719, 4 ]
[ 732, 32 ]
python
en
['en', 'error', 'th']
False
Annotation.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 everyth...
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 everyth...
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` ...
[ "def", "standoff", "(", "self", ")", ":", "return", "self", "[", "\"standoff\"", "]" ]
[ 741, 4 ]
[ 756, 31 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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]
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 """...
[ "def", "startarrowhead", "(", "self", ")", ":", "return", "self", "[", "\"startarrowhead\"", "]" ]
[ 765, 4 ]
[ 777, 37 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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]
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 i...
[ "def", "startarrowsize", "(", "self", ")", ":", "return", "self", "[", "\"startarrowsize\"", "]" ]
[ 786, 4 ]
[ 799, 37 ]
python
en
['en', 'error', 'th']
False
Annotation.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 every...
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 every...
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 `...
[ "def", "startstandoff", "(", "self", ")", ":", "return", "self", "[", "\"startstandoff\"", "]" ]
[ 808, 4 ]
[ 823, 36 ]
python
en
['en', 'error', 'th']
False
Annotation.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 (includ...
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 (includ...
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`, ...
[ "def", "templateitemname", "(", "self", ")", ":", "return", "self", "[", "\"templateitemname\"", "]" ]
[ 832, 4 ]
[ 851, 39 ]
python
en
['en', 'error', 'th']
False
Annotation.text
(self)
Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported. The 'text' property is a string and must...
Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported. The 'text' property is a string and must...
def text(self): """ Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported. The 'text' pr...
[ "def", "text", "(", "self", ")", ":", "return", "self", "[", "\"text\"", "]" ]
[ 860, 4 ]
[ 875, 27 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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 ...
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 equiva...
[ "def", "textangle", "(", "self", ")", ":", "return", "self", "[", "\"textangle\"", "]" ]
[ 884, 4 ]
[ 898, 32 ]
python
en
['en', 'error', 'th']
False
Annotation.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', 'mid...
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', 'mid...
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:...
[ "def", "valign", "(", "self", ")", ":", "return", "self", "[", "\"valign\"", "]" ]
[ 907, 4 ]
[ 921, 29 ]
python
en
['en', 'error', 'th']
False
Annotation.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
Determines whether or not this annotation is visible. The 'visible' property must be specified as a bool (either True, or False)
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"]
[ "def", "visible", "(", "self", ")", ":", "return", "self", "[", "\"visible\"", "]" ]
[ 930, 4 ]
[ 941, 30 ]
python
en
['en', 'error', 'th']
False
Annotation.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 <br> to start a new line. The 'width' property is a number and may be specified as: - An int or float in the interval [...
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 <br> to start a new line. The 'width' property is a number and may be specified as: - An int or float in the interval [...
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 <br> to start a new line. The 'width' property is a number and may be specified as: - An in...
[ "def", "width", "(", "self", ")", ":", "return", "self", "[", "\"width\"", "]" ]
[ 950, 4 ]
[ 963, 28 ]
python
en
['en', 'error', 'th']
False
Annotation.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 a...
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 a...
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 conver...
[ "def", "x", "(", "self", ")", ":", "return", "self", "[", "\"x\"", "]" ]
[ 972, 4 ]
[ 988, 24 ]
python
en
['en', 'error', 'th']
False
Annotation.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 rig...
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 rig...
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 an...
[ "def", "xanchor", "(", "self", ")", ":", "return", "self", "[", "\"xanchor\"", "]" ]
[ 997, 4 ]
[ 1017, 30 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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
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"]
[ "def", "xclick", "(", "self", ")", ":", "return", "self", "[", "\"xclick\"", "]" ]
[ 1026, 4 ]
[ 1037, 29 ]
python
en
['en', 'error', 'th']
False
Annotation.xref
(self)
Sets the annotation's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to ...
Sets the annotation's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to ...
def xref(self): """ Sets the annotation's x coordinate axis. If set to an x axis id (e.g. "x" or "x2"), the `x` position refers to an x coordinate If set to "paper", the `x` position refers to the distance from the left side of the plotting area in normalized coordinates ...
[ "def", "xref", "(", "self", ")", ":", "return", "self", "[", "\"xref\"", "]" ]
[ 1046, 4 ]
[ 1064, 27 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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
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 ...
[ "def", "xshift", "(", "self", ")", ":", "return", "self", "[", "\"xshift\"", "]" ]
[ 1073, 4 ]
[ 1085, 29 ]
python
en
['en', 'error', 'th']
False
Annotation.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 a...
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 a...
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 conver...
[ "def", "y", "(", "self", ")", ":", "return", "self", "[", "\"y\"", "]" ]
[ 1094, 4 ]
[ 1110, 24 ]
python
en
['en', 'error', 'th']
False
Annotation.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 ...
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 ...
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 annotati...
[ "def", "yanchor", "(", "self", ")", ":", "return", "self", "[", "\"yanchor\"", "]" ]
[ 1119, 4 ]
[ 1139, 30 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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
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"]
[ "def", "yclick", "(", "self", ")", ":", "return", "self", "[", "\"yclick\"", "]" ]
[ 1148, 4 ]
[ 1159, 29 ]
python
en
['en', 'error', 'th']
False
Annotation.yref
(self)
Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an 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...
Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an 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...
def yref(self): """ Sets the annotation's y coordinate axis. If set to an y axis id (e.g. "y" or "y2"), the `y` position refers to an y coordinate If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where ...
[ "def", "yref", "(", "self", ")", ":", "return", "self", "[", "\"yref\"", "]" ]
[ 1168, 4 ]
[ 1186, 27 ]
python
en
['en', 'error', 'th']
False
Annotation.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
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
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 """ ...
[ "def", "yshift", "(", "self", ")", ":", "return", "self", "[", "\"yshift\"", "]" ]
[ 1195, 4 ]
[ 1207, 29 ]
python
en
['en', 'error', 'th']
False
Annotation.__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...
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 `tex...
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 `tex...
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, bo...
[ "def", "__init__", "(", "self", ",", "arg", "=", "None", ",", "align", "=", "None", ",", "arrowcolor", "=", "None", ",", "arrowhead", "=", "None", ",", "arrowside", "=", "None", ",", "arrowsize", "=", "None", ",", "arrowwidth", "=", "None", ",", "ax"...
[ 1448, 4 ]
[ 1946, 34 ]
python
en
['en', 'error', 'th']
False
Rangebreak.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]' prop...
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]' prop...
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...
[ "def", "bounds", "(", "self", ")", ":", "return", "self", "[", "\"bounds\"", "]" ]
[ 23, 4 ]
[ 38, 29 ]
python
en
['en', 'error', 'th']
False
Rangebreak.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
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]
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 """ r...
[ "def", "dvalue", "(", "self", ")", ":", "return", "self", "[", "\"dvalue\"", "]" ]
[ 47, 4 ]
[ 59, 29 ]
python
en
['en', 'error', 'th']
False
Rangebreak.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
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)
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 ...
[ "def", "enabled", "(", "self", ")", ":", "return", "self", "[", "\"enabled\"", "]" ]
[ 68, 4 ]
[ 80, 30 ]
python
en
['en', 'error', 'th']
False
Rangebreak.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 ...
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 ...
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` al...
[ "def", "name", "(", "self", ")", ":", "return", "self", "[", "\"name\"", "]" ]
[ 89, 4 ]
[ 107, 27 ]
python
en
['en', 'error', 'th']
False
Rangebreak.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...
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...
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...
[ "def", "pattern", "(", "self", ")", ":", "return", "self", "[", "\"pattern\"", "]" ]
[ 116, 4 ]
[ 137, 30 ]
python
en
['en', 'error', 'th']
False
Rangebreak.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 (includ...
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 (includ...
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`, ...
[ "def", "templateitemname", "(", "self", ")", ":", "return", "self", "[", "\"templateitemname\"", "]" ]
[ 146, 4 ]
[ 165, 39 ]
python
en
['en', 'error', 'th']
False
Rangebreak.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]' propert...
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]' propert...
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: ...
[ "def", "values", "(", "self", ")", ":", "return", "self", "[", "\"values\"", "]" ]
[ 174, 4 ]
[ 188, 29 ]
python
en
['en', 'error', 'th']
False
Rangebreak.__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...
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...
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 ---...
[ "def", "__init__", "(", "self", ",", "arg", "=", "None", ",", "bounds", "=", "None", ",", "dvalue", "=", "None", ",", "enabled", "=", "None", ",", "name", "=", "None", ",", "pattern", "=", "None", ",", "templateitemname", "=", "None", ",", "values", ...
[ 246, 4 ]
[ 381, 34 ]
python
en
['en', 'error', 'th']
False
BaseWireFormat.__init__
(self)
Initialize the base wire format instance.
Initialize the base wire format instance.
def __init__(self): """Initialize the base wire format instance."""
[ "def", "__init__", "(", "self", ")", ":" ]
[ 20, 4 ]
[ 21, 55 ]
python
en
['en', 'en', 'en']
True