diff --git a/CHANGELOG.md b/CHANGELOG.md index 8899722ee74..a98e8c23015 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## Unreleased +## [6.5.2] - 2026-01-14 + +### Fixed +- Fix issue where pie trace `legend`, `showlegend` attributes don't accept array values [[#5464](https://github.com/plotly/plotly.py/pull/5464) and [#5465](https://github.com/plotly/plotly.py/pull/5465)], with thanks to @my-tien for the contribution! + ## [6.5.1] - 2025-11-17 ### Fixed diff --git a/CITATION.cff b/CITATION.cff index 60e32c18c24..8d97efdde2e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -9,7 +9,7 @@ authors: - family-names: "Parmer" given-names: "Chris" title: "An interactive, open-source, and browser-based graphing library for Python" -version: 6.5.1 +version: 6.5.2 doi: 10.5281/zenodo.14503524 date-released: 2025-11-17 url: "https://github.com/plotly/plotly.py" diff --git a/_plotly_utils/basevalidators.py b/_plotly_utils/basevalidators.py index c4d40f9e178..ff7849cc931 100644 --- a/_plotly_utils/basevalidators.py +++ b/_plotly_utils/basevalidators.py @@ -632,24 +632,35 @@ class BooleanValidator(BaseValidator): "description": "A boolean (true/false) value.", "requiredOpts": [], "otherOpts": [ + "arrayOk", "dflt" ] }, """ - def __init__(self, plotly_name, parent_name, **kwargs): + def __init__(self, plotly_name, parent_name, array_ok=False, **kwargs): super(BooleanValidator, self).__init__( plotly_name=plotly_name, parent_name=parent_name, **kwargs ) + self.array_ok = array_ok def description(self): - return """\ - The '{plotly_name}' property must be specified as a bool - (either True, or False)""".format(plotly_name=self.plotly_name) + desc = """\ + The '{plotly_name}' property is a boolean and must be specified as: + - A boolean value: True or False""".format(plotly_name=self.plotly_name) + if self.array_ok: + desc += """ + - A tuple or list of the above""" + return desc def validate_coerce(self, v): if is_none_or_typed_array_spec(v): pass + elif self.array_ok and is_simple_array(v): + invalid_els = [e for e in v if not isinstance(e, bool)] + if invalid_els: + self.raise_invalid_elements(invalid_els[:10]) + v = to_scalar_or_list(v) elif not isinstance(v, bool): self.raise_invalid_val(v) @@ -1735,12 +1746,15 @@ class SubplotidValidator(BaseValidator): "dflt" ], "otherOpts": [ + "arrayOk", "regex" ] } """ - def __init__(self, plotly_name, parent_name, dflt=None, regex=None, **kwargs): + def __init__( + self, plotly_name, parent_name, dflt=None, regex=None, array_ok=False, **kwargs + ): if dflt is None and regex is None: raise ValueError("One or both of regex and deflt must be specified") @@ -1755,40 +1769,55 @@ def __init__(self, plotly_name, parent_name, dflt=None, regex=None, **kwargs): self.base = re.match(r"/\^(\w+)", regex).group(1) self.regex = self.base + r"(\d*)" + self.array_ok = array_ok def description(self): desc = """\ The '{plotly_name}' property is an identifier of a particular - subplot, of type '{base}', that may be specified as the string '{base}' - optionally followed by an integer >= 1 - (e.g. '{base}', '{base}1', '{base}2', '{base}3', etc.) - """.format(plotly_name=self.plotly_name, base=self.base) + subplot, of type '{base}', that may be specified as: + - the string '{base}' optionally followed by an integer >= 1 + (e.g. '{base}', '{base}1', '{base}2', '{base}3', etc.)""".format( + plotly_name=self.plotly_name, base=self.base + ) + if self.array_ok: + desc += """ + - A tuple or list of the above""" return desc def validate_coerce(self, v): - if v is None: - pass - elif not isinstance(v, str): - self.raise_invalid_val(v) - else: - # match = re.fullmatch(self.regex, v) - match = fullmatch(self.regex, v) + def coerce(value): + if not isinstance(value, str): + return value, False + match = fullmatch(self.regex, value) if not match: - is_valid = False + return value, False else: digit_str = match.group(1) if len(digit_str) > 0 and int(digit_str) == 0: - is_valid = False + return value, False elif len(digit_str) > 0 and int(digit_str) == 1: - # Remove 1 suffix (e.g. x1 -> x) - v = self.base - is_valid = True + return self.base, True else: - is_valid = True + return value, True - if not is_valid: - self.raise_invalid_val(v) - return v + if v is None: + pass + elif self.array_ok and is_simple_array(v): + values = [] + invalid_els = [] + for e in v: + coerced_e, success = coerce(e) + values.append(coerced_e) + if not success: + invalid_els.append(coerced_e) + if len(invalid_els) > 0: + self.raise_invalid_elements(invalid_els[:10]) + return values + else: + v, success = coerce(v) + if not success: + self.raise_invalid_val(self.base) + return v class FlaglistValidator(BaseValidator): diff --git a/doc/python/animations.md b/doc/python/animations.md index 763ec728428..af22e349af4 100644 --- a/doc/python/animations.md +++ b/doc/python/animations.md @@ -339,27 +339,6 @@ sliders_dict = { "steps": [] } -# make data -year = 1952 -for continent in continents: - dataset_by_year = dataset[dataset["year"] == year] - dataset_by_year_and_cont = dataset_by_year[ - dataset_by_year["continent"] == continent] - - data_dict = { - "x": list(dataset_by_year_and_cont["lifeExp"]), - "y": list(dataset_by_year_and_cont["gdpPercap"]), - "mode": "markers", - "text": list(dataset_by_year_and_cont["country"]), - "marker": { - "sizemode": "area", - "sizeref": 200000, - "size": list(dataset_by_year_and_cont["pop"]) - }, - "name": continent - } - fig_dict["data"].append(data_dict) - # make frames for year in years: frame = {"data": [], "name": str(year)} @@ -396,6 +375,9 @@ for year in years: fig_dict["layout"]["sliders"] = [sliders_dict] +# make data +fig_dict["data"] = fig_dict["frames"][0]['data'] + fig = go.Figure(fig_dict) fig.show() diff --git a/doc/python/choropleth-maps.md b/doc/python/choropleth-maps.md index 78573bcf310..d16330a6d61 100644 --- a/doc/python/choropleth-maps.md +++ b/doc/python/choropleth-maps.md @@ -216,7 +216,7 @@ In **Plotly.py 6.3 and later**, the built-in countries geometry is created from In **earlier versions of Plotly.py**, the built-in countries geometry is based on Natural Earth data only. Plotly includes data from Natural Earth "as-is". This dataset draws boundaries of countries according to de facto status. See the [Natural Earth page for more details](https://www.naturalearthdata.com/downloads/50m-cultural-vectors/50m-admin-0-countries-2/). -To use the built-in countries geometry, provide `locations` as [three-letter ISO country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3). +To use the built-in countries geometry, provide `locations` as [three-letter ISO country codes](/python/outline-map-locations/#supported-iso-codes). ```python import plotly.express as px @@ -229,7 +229,7 @@ fig = px.choropleth(df, locations="iso_alpha", fig.show() ``` -To use the USA States geometry, set `locationmode='USA-states'` and provide `locations` as two-letter state abbreviations: +To use the USA States geometry, set `locationmode='USA-states'` and provide `locations` as [two-letter state abbreviations](/python/outline-map-locations/#supported-us-state-codes): ```python import plotly.express as px diff --git a/doc/python/dendrogram.md b/doc/python/dendrogram.md index 0fe8968f202..994ac0e408b 100644 --- a/doc/python/dendrogram.md +++ b/doc/python/dendrogram.md @@ -79,7 +79,7 @@ fig.show() #### Plot a Dendrogram with a Heatmap -See also the [Dash Bio demo](https://dash-bio.plotly.host/dash-clustergram/). +This example uses randomly generated sample data to demonstrate how to plot a dendrogram with a heatmap. ```python import plotly.graph_objects as go @@ -89,12 +89,11 @@ import numpy as np from scipy.spatial.distance import pdist, squareform -# get data -data = np.genfromtxt("http://files.figshare.com/2133304/ExpRawData_E_TABM_84_A_AFFY_44.tab", - names=True,usecols=tuple(range(1,30)),dtype=float, delimiter="\t") -data_array = data.view((float, len(data.dtype.names))) -data_array = data_array.transpose() -labels = data.dtype.names +# Generate sample data +np.random.seed(1) +X = np.random.rand(15, 15) +labels = [f'Sample_{i}' for i in range(15)] +data_array = X # Initialize figure by creating upper dendrogram fig = ff.create_dendrogram(data_array, orientation='bottom', labels=labels) diff --git a/doc/python/location-mode.md b/doc/python/location-mode.md new file mode 100644 index 00000000000..4fd607ee9d9 --- /dev/null +++ b/doc/python/location-mode.md @@ -0,0 +1,479 @@ +--- +jupyter: + jupytext: + notebook_metadata_filter: all + text_representation: + extension: .md + format_name: markdown + format_version: '1.3' + jupytext_version: 1.17.2 + kernelspec: + display_name: Python 3 (ipykernel) + language: python + name: python3 + language_info: + codemirror_mode: + name: ipython + version: 3 + file_extension: .py + mimetype: text/x-python + name: python + nbconvert_exporter: python + pygments_lexer: ipython3 + version: 3.10.0 + plotly: + description: How to specify country codes, names, and US states for outline-based + maps + display_as: maps + language: python + layout: base + name: Locations for Outline-based Maps + order: 15 + page_type: example_index + permalink: python/outline-map-locations/ + thumbnail: thumbnail/choropleth.jpg +--- + +# Locations for Outline-based Maps + +With outline-based maps, you can visualize data for specific regions using the `locations` and `locationmode` parameters. + +The following map types in `plotly.express` and `plotly.graph_objects` support these parameters: + +- `px.choropleth` - color regions based on data values +- `px.scatter_geo` - show markers at geographic locations +- `px.line_geo` - draw lines connecting geographic locations +- `go.Choropleth` - choropleth trace for coloring regions +- `go.Scattergeo` - geographic scatter/line trace for markers and lines + +The `locations` parameter accepts region identifiers and the `locationmode` parameter controls how those identifiers are interpreted: + +- `'ISO-3'` - three-letter ISO country codes (for example, `'USA'`, `'CAN'`, `'GBR'`) +- `'USA-states'` - two-letter US state abbreviations (for example, `'CA'`, `'TX'`, `'NY'`) +- `'country names'` - full country names (for example, `'United States'`) + + +## locationmode='ISO-3' + +Set `locationmode='ISO-3'` to use three-letter ISO country codes in `locations`. + +```python +import plotly.express as px + +fig = px.choropleth( + locations=['USA', 'CAN', 'MEX', 'BRA', 'RUS'], + locationmode='ISO-3', + color=[100, 85, 72, 95, 68], + color_continuous_scale='Viridis', + title='Choropleth with ISO-3 Country Codes' +) +fig.show() +``` + +## Supported ISO Codes + +The following ISO codes are supported when `locationmode='ISO-3'`: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameISO Code
AfghanistanAFG
Aksai ChinXAC
Åland IslandsALA
AlbaniaALB
AlgeriaDZA
American SamoaASM
AndorraAND
AngolaAGO
AnguillaAIA
AntarcticaATA
Antigua and BarbudaATG
ArgentinaARG
ArmeniaARM
ArubaABW
Arunachal PradeshXAP
AustraliaAUS
AustriaAUT
AzerbaijanAZE
Azores IslandsPRT
BahamasBHS
BahrainBHR
BangladeshBGD
BarbadosBRB
BelarusBLR
BelgiumBEL
BelizeBLZ
BeninBEN
BermudaBMU
BhutanBTN
Bir TawilXBT
Bolivia (Plurinational State of)BOL
BonaireBES
Bosnia and HerzegovinaBIH
BotswanaBWA
Bouvet IslandBVT
BrazilBRA
British Virgin IslandsVGB
Brunei DarussalamBRN
BulgariaBGR
Burkina FasoBFA
BurundiBDI
Cabo VerdeCPV
CambodiaKHM
CameroonCMR
CanadaCAN
Canary IslandsESP
Cayman IslandsCYM
Central African RepublicCAF
ChadTCD
Chagos ArchipelagoMUS
ChileCHL
ChinaCHN
Christmas IslandCXR
Cocos (Keeling) IslandsCCK
ColombiaCOL
ComorosCOM
CongoCOG
Cook IslandsCOK
Costa RicaCRI
Côte d'IvoireCIV
CroatiaHRV
CubaCUB
CuraçaoCUW
CyprusCYP
CzechiaCZE
Democratic People's Republic of KoreaPRK
Democratic Republic of the CongoCOD
DenmarkDNK
DjiboutiDJI
DominicaDMA
Dominican RepublicDOM
EcuadorECU
EgyptEGY
El SalvadorSLV
Equatorial GuineaGNQ
EritreaERI
EstoniaEST
EswatiniSWZ
EthiopiaETH
Falkland Islands (Malvinas)FLK
Faroe IslandsFRO
FijiFJI
FinlandFIN
FranceFRA
French GuianaGUF
French PolynesiaPYF
French Southern TerritoriesATF
GabonGAB
Galápagos IslandsECU
GambiaGMB
GazaPSE
GeorgiaGEO
GermanyDEU
GhanaGHA
GibraltarGIB
GreeceGRC
GreenlandGRL
GrenadaGRD
GuadeloupeGLP
GuamGUM
GuatemalaGTM
GuernseyGGY
GuineaGIN
Guinea-BissauGNB
GuyanaGUY
HaitiHTI
Halaib TriangleXHT
Heard Island and McDonald IslandsHMD
HondurasHND
Hong KongHKG
HungaryHUN
IcelandISL
Ilemi TriangleXIT
IndiaIND
IndonesiaIDN
Iran (Islamic Republic of)IRN
IraqIRQ
IrelandIRL
Isle of ManIMN
IsraelISR
ItalyITA
JamaicaJAM
Jammu and KashmirXJK
JapanJPN
JerseyJEY
JordanJOR
KazakhstanKAZ
KenyaKEN
Kingdom of the NetherlandsNLD
KiribatiKIR
KuwaitKWT
KyrgyzstanKGZ
Lao People's Democratic RepublicLAO
LatviaLVA
LebanonLBN
LesothoLSO
LiberiaLBR
LibyaLBY
LiechtensteinLIE
LithuaniaLTU
LuxembourgLUX
MacaoMAC
MadagascarMDG
Madeira IslandPRT
MalawiMWI
MalaysiaMYS
MaldivesMDV
MaliMLI
MaltaMLT
Marshall IslandsMHL
MartiniqueMTQ
MauritaniaMRT
MauritiusMUS
MayotteMYT
MexicoMEX
Micronesia (Federated States of)FSM
MonacoMCO
MongoliaMNG
MontenegroMNE
MontserratMSR
MoroccoMAR
MozambiqueMOZ
MyanmarMMR
NamibiaNAM
NauruNRU
NepalNPL
New CaledoniaNCL
New ZealandNZL
NicaraguaNIC
NigerNER
NigeriaNGA
NiueNIU
Norfolk IslandNFK
North MacedoniaMKD
Northern Mariana IslandsMNP
NorwayNOR
OmanOMN
PakistanPAK
PalauPLW
PanamaPAN
Papua New GuineaPNG
ParaguayPRY
PeruPER
PhilippinesPHL
PitcairnPCN
PolandPOL
PortugalPRT
Puerto RicoPRI
QatarQAT
Republic of KoreaKOR
Republic of MoldovaMDA
RéunionREU
RomaniaROU
Russian FederationRUS
RwandaRWA
SabaBES
Saint BarthélemyBLM
Saint HelenaSHN
Saint Kitts and NevisKNA
Saint LuciaLCA
Saint MartinMAF
Saint Pierre and MiquelonSPM
Saint Vincent and the GrenadinesVCT
SamoaWSM
Sao Tome and PrincipeSTP
Saudi ArabiaSAU
SenegalSEN
SerbiaSRB
SeychellesSYC
Sierra LeoneSLE
SingaporeSGP
Sint EustatiusBES
Sint MaartenSXM
SlovakiaSVK
SloveniaSVN
Solomon IslandsSLB
SomaliaSOM
South AfricaZAF
South Georgia and the South Sandwich IslandsSGS
South SudanSSD
SpainESP
Sri LankaLKA
SudanSDN
SurinameSUR
Svalbard and Jan Mayen IslandsSJM
SwedenSWE
SwitzerlandCHE
Syrian Arab RepublicSYR
TaiwanTWN
TajikistanTJK
ThailandTHA
Timor-LesteTLS
TogoTGO
TokelauTKL
TongaTON
Trinidad and TobagoTTO
TunisiaTUN
TürkiyeTUR
TurkmenistanTKM
Turks and Caicos IslandsTCA
TuvaluTUV
UgandaUGA
UkraineUKR
United Arab EmiratesARE
United Kingdom of Great Britain and Northern IrelandGBR
United Republic of TanzaniaTZA
United States of AmericaUSA
United States Virgin IslandsVIR
UruguayURY
UzbekistanUZB
VanuatuVUT
Venezuela (Bolivarian Republic of)VEN
Viet NamVNM
West BankPSE
Western SaharaESH
YemenYEM
ZambiaZMB
ZimbabweZWE
+ + +## locationmode='USA-states' + +Set `locationmode='USA-states'` to use two-letter US state abbreviations in `locations`. + +```python +import plotly.express as px + +fig = px.choropleth( + locations=['CA', 'TX', 'NY', 'FL', 'IL'], + locationmode='USA-states', + color=[95, 88, 92, 85, 78], + scope='usa', + color_continuous_scale='Reds', + title='USA States Choropleth' +) +fig.show() +``` + +## Supported US State Codes + +The following state codes are supported when `locationmode='USA-states'`: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
StateCode
AlabamaAL
AlaskaAK
ArizonaAZ
ArkansasAR
CaliforniaCA
ColoradoCO
ConnecticutCT
DelawareDE
District of ColumbiaDC
FloridaFL
GeorgiaGA
HawaiiHI
IdahoID
IllinoisIL
IndianaIN
IowaIA
KansasKS
KentuckyKY
LouisianaLA
MaineME
MarylandMD
MassachusettsMA
MichiganMI
MinnesotaMN
MississippiMS
MissouriMO
MontanaMT
NebraskaNE
NevadaNV
New HampshireNH
New JerseyNJ
New MexicoNM
New YorkNY
North CarolinaNC
North DakotaND
OhioOH
OklahomaOK
OregonOR
PennsylvaniaPA
Rhode IslandRI
South CarolinaSC
South DakotaSD
TennesseeTN
TexasTX
UtahUT
VermontVT
VirginiaVA
WashingtonWA
West VirginiaWV
WisconsinWI
WyomingWY
+ + +## locationmode='country names' + +Set `locationmode='country names'` to use full country names in `locations`. + +```python +import plotly.express as px + +fig = px.choropleth( + locations=['United States', 'Canada', 'United Kingdom'], + locationmode='country names' +) +fig.show() +``` + +> How Plotly matches 'country names' will change in a future version. Matching will become stricter and some country names may no longer match. We recommend using `locationmode='ISO-3'` with ISO codes for `locations` to ensure consistent behavior across versions. + +```python +import plotly.express as px + +fig = px.choropleth( + locations=['USA', 'CAN', 'GBR'], + locationmode='ISO-3' +) +fig.show() +``` + +## Using Different Data Types with `locations` + +Earlier examples demonstrated using the `locations` parameter with Python lists. The `locations` parameter also accepts column names from DataFrames, pandas Series, or other array-like objects. + +Here's an example that uses a column from the gapminder dataset with `locations`: + +```python +import plotly.express as px + +df = px.data.gapminder().query("year == 2007") + +fig = px.choropleth( + df, + locations='iso_alpha', + locationmode='ISO-3', + color='lifeExp', + hover_name='country', + color_continuous_scale='Viridis', + title='Life Expectancy by Country (2007)' +) +fig.show() +``` diff --git a/doc/python/ml-pca.md b/doc/python/ml-pca.md index 1776d3be393..fc96eaf7aa2 100644 --- a/doc/python/ml-pca.md +++ b/doc/python/ml-pca.md @@ -105,16 +105,16 @@ fig.show() When you will have too many features to visualize, you might be interested in only visualizing the most relevant components. Those components often capture a majority of the [explained variance](https://en.wikipedia.org/wiki/Explained_variation), which is a good way to tell if those components are sufficient for modelling this dataset. -In the example below, our dataset contains 8 features, but we only select the first 2 components. +In the example below, our dataset contains 10 features, but we only select the first 2 components. ```python import pandas as pd import plotly.express as px from sklearn.decomposition import PCA -from sklearn.datasets import fetch_california_housing +from sklearn.datasets import load_diabetes -housing = fetch_california_housing(as_frame=True) -df = housing.data +diabetes = load_diabetes() +df = pd.DataFrame(diabetes.data, columns=diabetes.feature_names) n_components = 2 pca = PCA(n_components=n_components) @@ -123,11 +123,11 @@ components = pca.fit_transform(df) total_var = pca.explained_variance_ratio_.sum() * 100 labels = {str(i): f"PC {i+1}" for i in range(n_components)} -labels['color'] = 'Median Price' +labels['color'] = 'Disease Progression' fig = px.scatter_matrix( components, - color=housing.target, + color=diabetes.target, dimensions=range(n_components), labels=labels, title=f'Total Explained Variance: {total_var:.2f}%', diff --git a/plotly/graph_objs/_bar.py b/plotly/graph_objs/_bar.py index 144c8dfab61..e2cd24617f7 100644 --- a/plotly/graph_objs/_bar.py +++ b/plotly/graph_objs/_bar.py @@ -154,8 +154,8 @@ def cliponaxis(self): make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -580,9 +580,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -927,8 +927,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1341,9 +1341,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1531,9 +1531,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_barpolar.py b/plotly/graph_objs/_barpolar.py index 641914cc162..9f414c9adc8 100644 --- a/plotly/graph_objs/_barpolar.py +++ b/plotly/graph_objs/_barpolar.py @@ -408,9 +408,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -747,8 +747,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -788,9 +788,9 @@ def subplot(self): `layout.polar2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'polar', that may be specified as the string 'polar' - optionally followed by an integer >= 1 - (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + subplot, of type 'polar', that may be specified as: + - the string 'polar' optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) Returns ------- diff --git a/plotly/graph_objs/_box.py b/plotly/graph_objs/_box.py index f2e52c8d0ce..0309be1a405 100644 --- a/plotly/graph_objs/_box.py +++ b/plotly/graph_objs/_box.py @@ -546,9 +546,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -879,8 +879,8 @@ def notched(self): box-plots for more info. Defaults to False unless `notchwidth` or `notchspan` is set. - The 'notched' property must be specified as a bool - (either True, or False) + The 'notched' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1245,8 +1245,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1264,8 +1264,8 @@ def showwhiskers(self): Determines whether or not whiskers are visible. Defaults to true for `sizemode` "quartiles", false for "sd". - The 'showwhiskers' property must be specified as a bool - (either True, or False) + The 'showwhiskers' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1579,9 +1579,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1770,9 +1770,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_candlestick.py b/plotly/graph_objs/_candlestick.py index b14e1dcd0f6..67131d8fa0b 100644 --- a/plotly/graph_objs/_candlestick.py +++ b/plotly/graph_objs/_candlestick.py @@ -448,9 +448,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -747,8 +747,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -939,9 +939,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1092,9 +1092,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_carpet.py b/plotly/graph_objs/_carpet.py index b75b58a683d..26e6a7a75f4 100644 --- a/plotly/graph_objs/_carpet.py +++ b/plotly/graph_objs/_carpet.py @@ -408,9 +408,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -687,9 +687,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -746,9 +746,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_choropleth.py b/plotly/graph_objs/_choropleth.py index fa6fe7226b9..d4be517e4d3 100644 --- a/plotly/graph_objs/_choropleth.py +++ b/plotly/graph_objs/_choropleth.py @@ -72,8 +72,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -96,9 +96,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -251,9 +251,9 @@ def geo(self): geospatial coordinates refer to `layout.geo2`, and so on. The 'geo' property is an identifier of a particular - subplot, of type 'geo', that may be specified as the string 'geo' - optionally followed by an integer >= 1 - (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) + subplot, of type 'geo', that may be specified as: + - the string 'geo' optionally followed by an integer >= 1 + (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) Returns ------- @@ -519,9 +519,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -771,8 +771,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -831,8 +831,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -850,8 +850,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1037,8 +1037,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_choroplethmap.py b/plotly/graph_objs/_choroplethmap.py index 70caf5bfd31..eb548811ab4 100644 --- a/plotly/graph_objs/_choroplethmap.py +++ b/plotly/graph_objs/_choroplethmap.py @@ -71,8 +71,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -117,9 +117,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -516,9 +516,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -742,8 +742,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -802,8 +802,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -821,8 +821,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -862,9 +862,9 @@ def subplot(self): so on. The 'subplot' property is an identifier of a particular - subplot, of type 'map', that may be specified as the string 'map' - optionally followed by an integer >= 1 - (e.g. 'map', 'map1', 'map2', 'map3', etc.) + subplot, of type 'map', that may be specified as: + - the string 'map' optionally followed by an integer >= 1 + (e.g. 'map', 'map1', 'map2', 'map3', etc.) Returns ------- @@ -1031,8 +1031,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_choroplethmapbox.py b/plotly/graph_objs/_choroplethmapbox.py index efe8509ab90..b89f6f022cd 100644 --- a/plotly/graph_objs/_choroplethmapbox.py +++ b/plotly/graph_objs/_choroplethmapbox.py @@ -72,8 +72,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -118,9 +118,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -517,9 +517,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -743,8 +743,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -803,8 +803,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -822,8 +822,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -867,9 +867,9 @@ def subplot(self): `layout.mapbox2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'mapbox', that may be specified as the string 'mapbox' - optionally followed by an integer >= 1 - (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) + subplot, of type 'mapbox', that may be specified as: + - the string 'mapbox' optionally followed by an integer >= 1 + (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) Returns ------- @@ -1036,8 +1036,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_cone.py b/plotly/graph_objs/_cone.py index df2aa740ec3..29de7ce02f9 100644 --- a/plotly/graph_objs/_cone.py +++ b/plotly/graph_objs/_cone.py @@ -105,8 +105,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -126,8 +126,8 @@ def cauto(self): in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -211,9 +211,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -569,9 +569,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -799,8 +799,8 @@ def reversescale(self): correspond to the last color in the array and `cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -821,9 +821,9 @@ def scene(self): coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + subplot, of type 'scene', that may be specified as: + - the string 'scene' optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- @@ -841,8 +841,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -860,8 +860,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_contour.py b/plotly/graph_objs/_contour.py index c83b911d389..c2c9f0dcc00 100644 --- a/plotly/graph_objs/_contour.py +++ b/plotly/graph_objs/_contour.py @@ -97,8 +97,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -118,8 +118,8 @@ def autocontour(self): can be set in `ncontours`. If False, set the contour level attributes in `contours`. - The 'autocontour' property must be specified as a bool - (either True, or False) + The 'autocontour' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -142,9 +142,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -233,8 +233,8 @@ def connectgaps(self): in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -435,8 +435,8 @@ def hoverongaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. - The 'hoverongaps' property must be specified as a bool - (either True, or False) + The 'hoverongaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -617,9 +617,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -845,8 +845,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -864,8 +864,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -883,8 +883,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1034,8 +1034,8 @@ def transpose(self): """ Transposes the z data. - The 'transpose' property must be specified as a bool - (either True, or False) + The 'transpose' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1165,9 +1165,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1377,9 +1377,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- @@ -1569,8 +1569,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_contourcarpet.py b/plotly/graph_objs/_contourcarpet.py index 2a24b888e24..837b6d9a72c 100644 --- a/plotly/graph_objs/_contourcarpet.py +++ b/plotly/graph_objs/_contourcarpet.py @@ -153,8 +153,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,8 +174,8 @@ def autocontour(self): can be set in `ncontours`. If False, set the contour level attributes in `contours`. - The 'autocontour' property must be specified as a bool - (either True, or False) + The 'autocontour' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -295,9 +295,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -584,9 +584,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -812,8 +812,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -831,8 +831,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -850,8 +850,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -923,8 +923,8 @@ def transpose(self): """ Transposes the z data. - The 'transpose' property must be specified as a bool - (either True, or False) + The 'transpose' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1017,9 +1017,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1040,9 +1040,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- @@ -1080,8 +1080,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_densitymap.py b/plotly/graph_objs/_densitymap.py index 5e9d2e23500..c659825168c 100644 --- a/plotly/graph_objs/_densitymap.py +++ b/plotly/graph_objs/_densitymap.py @@ -70,8 +70,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -116,9 +116,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -513,9 +513,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -775,8 +775,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -794,8 +794,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -813,8 +813,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -854,9 +854,9 @@ def subplot(self): so on. The 'subplot' property is an identifier of a particular - subplot, of type 'map', that may be specified as the string 'map' - optionally followed by an integer >= 1 - (e.g. 'map', 'map1', 'map2', 'map3', etc.) + subplot, of type 'map', that may be specified as: + - the string 'map' optionally followed by an integer >= 1 + (e.g. 'map', 'map1', 'map2', 'map3', etc.) Returns ------- @@ -1010,8 +1010,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_densitymapbox.py b/plotly/graph_objs/_densitymapbox.py index 79584dbfb84..b3fb169b53a 100644 --- a/plotly/graph_objs/_densitymapbox.py +++ b/plotly/graph_objs/_densitymapbox.py @@ -71,8 +71,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -117,9 +117,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -514,9 +514,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -776,8 +776,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -795,8 +795,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -814,8 +814,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -859,9 +859,9 @@ def subplot(self): `layout.mapbox2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'mapbox', that may be specified as the string 'mapbox' - optionally followed by an integer >= 1 - (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) + subplot, of type 'mapbox', that may be specified as: + - the string 'mapbox' optionally followed by an integer >= 1 + (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) Returns ------- @@ -1015,8 +1015,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_funnel.py b/plotly/graph_objs/_funnel.py index f20e85e5197..244c2861bbd 100644 --- a/plotly/graph_objs/_funnel.py +++ b/plotly/graph_objs/_funnel.py @@ -109,8 +109,8 @@ def cliponaxis(self): make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -517,9 +517,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -830,8 +830,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1230,9 +1230,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1398,9 +1398,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_funnelarea.py b/plotly/graph_objs/_funnelarea.py index f02efa0902c..a3db350eb99 100644 --- a/plotly/graph_objs/_funnelarea.py +++ b/plotly/graph_objs/_funnelarea.py @@ -492,9 +492,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -718,8 +718,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_heatmap.py b/plotly/graph_objs/_heatmap.py index aa402d70ae7..69d10f2a18a 100644 --- a/plotly/graph_objs/_heatmap.py +++ b/plotly/graph_objs/_heatmap.py @@ -95,8 +95,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -119,9 +119,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -211,8 +211,8 @@ def connectgaps(self): is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -368,8 +368,8 @@ def hoverongaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them. - The 'hoverongaps' property must be specified as a bool - (either True, or False) + The 'hoverongaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -550,9 +550,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -737,8 +737,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -756,8 +756,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -775,8 +775,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -924,8 +924,8 @@ def transpose(self): """ Transposes the z data. - The 'transpose' property must be specified as a bool - (either True, or False) + The 'transpose' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1055,9 +1055,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1285,9 +1285,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- @@ -1495,8 +1495,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_histogram.py b/plotly/graph_objs/_histogram.py index 26789167d16..f642f05be87 100644 --- a/plotly/graph_objs/_histogram.py +++ b/plotly/graph_objs/_histogram.py @@ -109,8 +109,8 @@ def autobinx(self): `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. - The 'autobinx' property must be specified as a bool - (either True, or False) + The 'autobinx' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -130,8 +130,8 @@ def autobiny(self): `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. - The 'autobiny' property must be specified as a bool - (either True, or False) + The 'autobiny' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -176,8 +176,8 @@ def cliponaxis(self): make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -637,9 +637,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -989,8 +989,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1305,9 +1305,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1434,9 +1434,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_histogram2d.py b/plotly/graph_objs/_histogram2d.py index 91520682b9a..67a70a6db6a 100644 --- a/plotly/graph_objs/_histogram2d.py +++ b/plotly/graph_objs/_histogram2d.py @@ -85,8 +85,8 @@ def autobinx(self): `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. - The 'autobinx' property must be specified as a bool - (either True, or False) + The 'autobinx' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -106,8 +106,8 @@ def autobiny(self): `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. - The 'autobiny' property must be specified as a bool - (either True, or False) + The 'autobiny' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -129,8 +129,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -549,9 +549,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -799,8 +799,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -818,8 +818,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -837,8 +837,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1044,9 +1044,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1214,9 +1214,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- @@ -1383,8 +1383,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_histogram2dcontour.py b/plotly/graph_objs/_histogram2dcontour.py index 3284ff151aa..c36c7078033 100644 --- a/plotly/graph_objs/_histogram2dcontour.py +++ b/plotly/graph_objs/_histogram2dcontour.py @@ -86,8 +86,8 @@ def autobinx(self): `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. - The 'autobinx' property must be specified as a bool - (either True, or False) + The 'autobinx' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -107,8 +107,8 @@ def autobiny(self): `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. - The 'autobiny' property must be specified as a bool - (either True, or False) + The 'autobiny' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -130,8 +130,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -151,8 +151,8 @@ def autocontour(self): can be set in `ncontours`. If False, set the contour level attributes in `contours`. - The 'autocontour' property must be specified as a bool - (either True, or False) + The 'autocontour' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -196,9 +196,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -590,9 +590,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -881,8 +881,8 @@ def reversescale(self): 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) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -900,8 +900,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -919,8 +919,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1128,9 +1128,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1280,9 +1280,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- @@ -1431,8 +1431,8 @@ def zauto(self): `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. - The 'zauto' property must be specified as a bool - (either True, or False) + The 'zauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_icicle.py b/plotly/graph_objs/_icicle.py index 3f8986f5e6e..c1909cbe7e0 100644 --- a/plotly/graph_objs/_icicle.py +++ b/plotly/graph_objs/_icicle.py @@ -483,9 +483,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -810,8 +810,8 @@ def sort(self): Determines whether or not the sectors are reordered from largest to smallest. - The 'sort' property must be specified as a bool - (either True, or False) + The 'sort' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_image.py b/plotly/graph_objs/_image.py index 5f150b59f41..e1ebdbe36fe 100644 --- a/plotly/graph_objs/_image.py +++ b/plotly/graph_objs/_image.py @@ -382,9 +382,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -717,9 +717,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -762,9 +762,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_indicator.py b/plotly/graph_objs/_indicator.py index ae354501efc..e54f53442e7 100644 --- a/plotly/graph_objs/_indicator.py +++ b/plotly/graph_objs/_indicator.py @@ -202,9 +202,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- diff --git a/plotly/graph_objs/_isosurface.py b/plotly/graph_objs/_isosurface.py index 70cdfecbf7e..f68216dcfbd 100644 --- a/plotly/graph_objs/_isosurface.py +++ b/plotly/graph_objs/_isosurface.py @@ -83,8 +83,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -123,8 +123,8 @@ def cauto(self): `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -205,9 +205,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -355,8 +355,8 @@ def flatshading(self): meshes, creating meshes with an angular, low-poly look via flat reflections. - The 'flatshading' property must be specified as a bool - (either True, or False) + The 'flatshading' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -637,9 +637,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -867,8 +867,8 @@ def reversescale(self): correspond to the last color in the array and `cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -889,9 +889,9 @@ def scene(self): coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + subplot, of type 'scene', that may be specified as: + - the string 'scene' optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- @@ -909,8 +909,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -928,8 +928,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_layout.py b/plotly/graph_objs/_layout.py index 2a08e494b44..5917d7d574c 100644 --- a/plotly/graph_objs/_layout.py +++ b/plotly/graph_objs/_layout.py @@ -241,8 +241,8 @@ def autosize(self): layout width or height is always initialized on the first call to plot. - The 'autosize' property must be specified as a bool - (either True, or False) + The 'autosize' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -654,8 +654,8 @@ def extendfunnelareacolors(self): Colors provided in the trace, using `marker.colors`, are never extended. - The 'extendfunnelareacolors' property must be specified as a bool - (either True, or False) + The 'extendfunnelareacolors' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -679,8 +679,8 @@ def extendiciclecolors(self): provided in the trace, using `marker.colors`, are never extended. - The 'extendiciclecolors' property must be specified as a bool - (either True, or False) + The 'extendiciclecolors' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -703,8 +703,8 @@ def extendpiecolors(self): but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended. - The 'extendpiecolors' property must be specified as a bool - (either True, or False) + The 'extendpiecolors' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -728,8 +728,8 @@ def extendsunburstcolors(self): Colors provided in the trace, using `marker.colors`, are never extended. - The 'extendsunburstcolors' property must be specified as a bool - (either True, or False) + The 'extendsunburstcolors' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -753,8 +753,8 @@ def extendtreemapcolors(self): Colors provided in the trace, using `marker.colors`, are never extended. - The 'extendtreemapcolors' property must be specified as a bool - (either True, or False) + The 'extendtreemapcolors' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -976,8 +976,8 @@ def hidesources(self): graphs from the Chart Studio Cloud (at https://chart- studio.plotly.com or on-premise). - The 'hidesources' property must be specified as a bool - (either True, or False) + The 'hidesources' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1668,8 +1668,8 @@ def showlegend(self): trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`. - The 'showlegend' property must be specified as a bool - (either True, or False) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_mesh3d.py b/plotly/graph_objs/_mesh3d.py index 7cd2e8e3d15..231b7300a85 100644 --- a/plotly/graph_objs/_mesh3d.py +++ b/plotly/graph_objs/_mesh3d.py @@ -126,8 +126,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def cauto(self): in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -256,9 +256,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -466,8 +466,8 @@ def flatshading(self): meshes, creating meshes with an angular, low-poly look via flat reflections. - The 'flatshading' property must be specified as a bool - (either True, or False) + The 'flatshading' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -895,9 +895,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -1125,8 +1125,8 @@ def reversescale(self): correspond to the last color in the array and `cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1147,9 +1147,9 @@ def scene(self): coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + subplot, of type 'scene', that may be specified as: + - the string 'scene' optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- @@ -1167,8 +1167,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1186,8 +1186,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_ohlc.py b/plotly/graph_objs/_ohlc.py index d00b40e986e..d8376e8aae6 100644 --- a/plotly/graph_objs/_ohlc.py +++ b/plotly/graph_objs/_ohlc.py @@ -448,9 +448,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -747,8 +747,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -939,9 +939,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1092,9 +1092,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_parcats.py b/plotly/graph_objs/_parcats.py index 1b54f6c4385..2c444dd54eb 100644 --- a/plotly/graph_objs/_parcats.py +++ b/plotly/graph_objs/_parcats.py @@ -65,8 +65,8 @@ def bundlecolors(self): Sort paths so that like colors are bundled together within each category. - The 'bundlecolors' property must be specified as a bool - (either True, or False) + The 'bundlecolors' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_parcoords.py b/plotly/graph_objs/_parcoords.py index e3f2f9a2641..b2ab85ef2b7 100644 --- a/plotly/graph_objs/_parcoords.py +++ b/plotly/graph_objs/_parcoords.py @@ -255,9 +255,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- diff --git a/plotly/graph_objs/_pie.py b/plotly/graph_objs/_pie.py index 8eb007c93ad..b18aad3e2df 100644 --- a/plotly/graph_objs/_pie.py +++ b/plotly/graph_objs/_pie.py @@ -74,8 +74,8 @@ def automargin(self): """ Determines whether outside text labels can push the margins. - The 'automargin' property must be specified as a bool - (either True, or False) + The 'automargin' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -550,9 +550,10 @@ def legend(self): `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + - A tuple or list of the above Returns ------- @@ -878,8 +879,9 @@ def showlegend(self): that case, each entry specifies appearance in the legend for one slice. - The 'showlegend' property must be specified as a bool - (either True, or False) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False + - A tuple or list of the above Returns ------- @@ -916,8 +918,8 @@ def sort(self): Determines whether or not the sectors are reordered from largest to smallest. - The 'sort' property must be specified as a bool - (either True, or False) + The 'sort' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_sankey.py b/plotly/graph_objs/_sankey.py index 0190fcf034b..f32d44f6fdd 100644 --- a/plotly/graph_objs/_sankey.py +++ b/plotly/graph_objs/_sankey.py @@ -213,9 +213,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scatter.py b/plotly/graph_objs/_scatter.py index efd3cdae62f..ad5ab6b624f 100644 --- a/plotly/graph_objs/_scatter.py +++ b/plotly/graph_objs/_scatter.py @@ -117,8 +117,8 @@ def cliponaxis(self): axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -136,8 +136,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -657,9 +657,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -994,8 +994,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1399,9 +1399,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1589,9 +1589,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scatter3d.py b/plotly/graph_objs/_scatter3d.py index 4c667281975..8247116c7da 100644 --- a/plotly/graph_objs/_scatter3d.py +++ b/plotly/graph_objs/_scatter3d.py @@ -75,8 +75,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -422,9 +422,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -694,9 +694,9 @@ def scene(self): coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + subplot, of type 'scene', that may be specified as: + - the string 'scene' optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- @@ -714,8 +714,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_scattercarpet.py b/plotly/graph_objs/_scattercarpet.py index 2e7738753c3..769556f1fb2 100644 --- a/plotly/graph_objs/_scattercarpet.py +++ b/plotly/graph_objs/_scattercarpet.py @@ -163,8 +163,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -527,9 +527,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -818,8 +818,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1131,9 +1131,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1154,9 +1154,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scattergeo.py b/plotly/graph_objs/_scattergeo.py index 54be1ed8d14..dc45749a6ec 100644 --- a/plotly/graph_objs/_scattergeo.py +++ b/plotly/graph_objs/_scattergeo.py @@ -72,8 +72,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -201,9 +201,9 @@ def geo(self): geospatial coordinates refer to `layout.geo2`, and so on. The 'geo' property is an identifier of a particular - subplot, of type 'geo', that may be specified as the string 'geo' - optionally followed by an integer >= 1 - (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) + subplot, of type 'geo', that may be specified as: + - the string 'geo' optionally followed by an integer >= 1 + (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) Returns ------- @@ -511,9 +511,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -903,8 +903,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_scattergl.py b/plotly/graph_objs/_scattergl.py index 9a2f80e8e1d..e2054bc71ca 100644 --- a/plotly/graph_objs/_scattergl.py +++ b/plotly/graph_objs/_scattergl.py @@ -83,8 +83,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -509,9 +509,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -795,8 +795,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1144,9 +1144,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1334,9 +1334,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scattermap.py b/plotly/graph_objs/_scattermap.py index 3183a9d0ebe..9d55304baca 100644 --- a/plotly/graph_objs/_scattermap.py +++ b/plotly/graph_objs/_scattermap.py @@ -108,8 +108,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -479,9 +479,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -804,8 +804,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -845,9 +845,9 @@ def subplot(self): so on. The 'subplot' property is an identifier of a particular - subplot, of type 'map', that may be specified as the string 'map' - optionally followed by an integer >= 1 - (e.g. 'map', 'map1', 'map2', 'map3', etc.) + subplot, of type 'map', that may be specified as: + - the string 'map' optionally followed by an integer >= 1 + (e.g. 'map', 'map1', 'map2', 'map3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scattermapbox.py b/plotly/graph_objs/_scattermapbox.py index 854d4d562e5..e6fe0cef217 100644 --- a/plotly/graph_objs/_scattermapbox.py +++ b/plotly/graph_objs/_scattermapbox.py @@ -110,8 +110,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -481,9 +481,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -806,8 +806,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -851,9 +851,9 @@ def subplot(self): `layout.mapbox2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'mapbox', that may be specified as the string 'mapbox' - optionally followed by an integer >= 1 - (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) + subplot, of type 'mapbox', that may be specified as: + - the string 'mapbox' optionally followed by an integer >= 1 + (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scatterpolar.py b/plotly/graph_objs/_scatterpolar.py index d0c1b471134..f982f739659 100644 --- a/plotly/graph_objs/_scatterpolar.py +++ b/plotly/graph_objs/_scatterpolar.py @@ -75,8 +75,8 @@ def cliponaxis(self): axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -94,8 +94,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -496,9 +496,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -842,8 +842,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -883,9 +883,9 @@ def subplot(self): `layout.polar2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'polar', that may be specified as the string 'polar' - optionally followed by an integer >= 1 - (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + subplot, of type 'polar', that may be specified as: + - the string 'polar' optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scatterpolargl.py b/plotly/graph_objs/_scatterpolargl.py index 1dca7c151cf..0205d08dbcf 100644 --- a/plotly/graph_objs/_scatterpolargl.py +++ b/plotly/graph_objs/_scatterpolargl.py @@ -71,8 +71,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -461,9 +461,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -807,8 +807,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -848,9 +848,9 @@ def subplot(self): `layout.polar2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'polar', that may be specified as the string 'polar' - optionally followed by an integer >= 1 - (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + subplot, of type 'polar', that may be specified as: + - the string 'polar' optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scattersmith.py b/plotly/graph_objs/_scattersmith.py index 2267ecad324..7d9fa8e76a1 100644 --- a/plotly/graph_objs/_scattersmith.py +++ b/plotly/graph_objs/_scattersmith.py @@ -70,8 +70,8 @@ def cliponaxis(self): axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -89,8 +89,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -491,9 +491,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -819,8 +819,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -860,9 +860,9 @@ def subplot(self): `layout.smith2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'smith', that may be specified as the string 'smith' - optionally followed by an integer >= 1 - (e.g. 'smith', 'smith1', 'smith2', 'smith3', etc.) + subplot, of type 'smith', that may be specified as: + - the string 'smith' optionally followed by an integer >= 1 + (e.g. 'smith', 'smith1', 'smith2', 'smith3', etc.) Returns ------- diff --git a/plotly/graph_objs/_scatterternary.py b/plotly/graph_objs/_scatterternary.py index 8333ec46178..2e80db08384 100644 --- a/plotly/graph_objs/_scatterternary.py +++ b/plotly/graph_objs/_scatterternary.py @@ -172,8 +172,8 @@ def cliponaxis(self): axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -191,8 +191,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -573,9 +573,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -864,8 +864,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -905,9 +905,9 @@ def subplot(self): `layout.ternary2`, and so on. The 'subplot' property is an identifier of a particular - subplot, of type 'ternary', that may be specified as the string 'ternary' - optionally followed by an integer >= 1 - (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.) + subplot, of type 'ternary', that may be specified as: + - the string 'ternary' optionally followed by an integer >= 1 + (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.) Returns ------- diff --git a/plotly/graph_objs/_splom.py b/plotly/graph_objs/_splom.py index 021745c66d4..c80229a7044 100644 --- a/plotly/graph_objs/_splom.py +++ b/plotly/graph_objs/_splom.py @@ -387,9 +387,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -633,8 +633,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -652,8 +652,8 @@ def showlowerhalf(self): Determines whether or not subplots on the lower half from the diagonal are displayed. - The 'showlowerhalf' property must be specified as a bool - (either True, or False) + The 'showlowerhalf' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -671,8 +671,8 @@ def showupperhalf(self): Determines whether or not subplots on the upper half from the diagonal are displayed. - The 'showupperhalf' property must be specified as a bool - (either True, or False) + The 'showupperhalf' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -848,9 +848,9 @@ def xaxes(self): The 'xaxes' property is an info array that may be specified as: * a list of elements where: The 'xaxes[i]' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -904,9 +904,9 @@ def yaxes(self): The 'yaxes' property is an info array that may be specified as: * a list of elements where: The 'yaxes[i]' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_streamtube.py b/plotly/graph_objs/_streamtube.py index ff88408387d..fe6bd78ffd7 100644 --- a/plotly/graph_objs/_streamtube.py +++ b/plotly/graph_objs/_streamtube.py @@ -82,8 +82,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -103,8 +103,8 @@ def cauto(self): in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -188,9 +188,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -527,9 +527,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -776,8 +776,8 @@ def reversescale(self): correspond to the last color in the array and `cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -798,9 +798,9 @@ def scene(self): coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + subplot, of type 'scene', that may be specified as: + - the string 'scene' optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- @@ -818,8 +818,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -837,8 +837,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_sunburst.py b/plotly/graph_objs/_sunburst.py index 70f84cfccd6..b7df56bfa01 100644 --- a/plotly/graph_objs/_sunburst.py +++ b/plotly/graph_objs/_sunburst.py @@ -508,9 +508,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -837,8 +837,8 @@ def sort(self): Determines whether or not the sectors are reordered from largest to smallest. - The 'sort' property must be specified as a bool - (either True, or False) + The 'sort' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_surface.py b/plotly/graph_objs/_surface.py index d31ddfe0af1..8a1dddc8b71 100644 --- a/plotly/graph_objs/_surface.py +++ b/plotly/graph_objs/_surface.py @@ -81,8 +81,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -102,8 +102,8 @@ def cauto(self): bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -187,9 +187,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -277,8 +277,8 @@ def connectgaps(self): Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. - The 'connectgaps' property must be specified as a bool - (either True, or False) + The 'connectgaps' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -356,8 +356,8 @@ def hidesurface(self): `hidesurface` to False `contours.x.show` to True and `contours.y.show` to True to draw a wire frame plot. - The 'hidesurface' property must be specified as a bool - (either True, or False) + The 'hidesurface' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -602,9 +602,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -857,8 +857,8 @@ def reversescale(self): correspond to the last color in the array and `cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -879,9 +879,9 @@ def scene(self): coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + subplot, of type 'scene', that may be specified as: + - the string 'scene' optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- @@ -899,8 +899,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -918,8 +918,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_table.py b/plotly/graph_objs/_table.py index 3bf76e1c76a..e58ec78d7d5 100644 --- a/plotly/graph_objs/_table.py +++ b/plotly/graph_objs/_table.py @@ -322,9 +322,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- diff --git a/plotly/graph_objs/_treemap.py b/plotly/graph_objs/_treemap.py index d577c253df1..4cced036174 100644 --- a/plotly/graph_objs/_treemap.py +++ b/plotly/graph_objs/_treemap.py @@ -463,9 +463,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -790,8 +790,8 @@ def sort(self): Determines whether or not the sectors are reordered from largest to smallest. - The 'sort' property must be specified as a bool - (either True, or False) + The 'sort' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_violin.py b/plotly/graph_objs/_violin.py index 0fa66f4e37b..ca03026d675 100644 --- a/plotly/graph_objs/_violin.py +++ b/plotly/graph_objs/_violin.py @@ -475,9 +475,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -929,8 +929,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1231,9 +1231,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1339,9 +1339,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/_volume.py b/plotly/graph_objs/_volume.py index d09baf33519..28edde3a074 100644 --- a/plotly/graph_objs/_volume.py +++ b/plotly/graph_objs/_volume.py @@ -84,8 +84,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -124,8 +124,8 @@ def cauto(self): `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -206,9 +206,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -356,8 +356,8 @@ def flatshading(self): meshes, creating meshes with an angular, low-poly look via flat reflections. - The 'flatshading' property must be specified as a bool - (either True, or False) + The 'flatshading' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -638,9 +638,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -893,8 +893,8 @@ def reversescale(self): correspond to the last color in the array and `cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -915,9 +915,9 @@ def scene(self): coordinates refer to `layout.scene2`, and so on. The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + subplot, of type 'scene', that may be specified as: + - the string 'scene' optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) Returns ------- @@ -935,8 +935,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -954,8 +954,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/_waterfall.py b/plotly/graph_objs/_waterfall.py index ec6d796d1af..ad71ced9652 100644 --- a/plotly/graph_objs/_waterfall.py +++ b/plotly/graph_objs/_waterfall.py @@ -134,8 +134,8 @@ def cliponaxis(self): make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*. - The 'cliponaxis' property must be specified as a bool - (either True, or False) + The 'cliponaxis' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -579,9 +579,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -928,8 +928,8 @@ 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) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1365,9 +1365,9 @@ def xaxis(self): `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) + subplot, of type 'x', that may be specified as: + - the string 'x' optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) Returns ------- @@ -1533,9 +1533,9 @@ def yaxis(self): `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) + subplot, of type 'y', that may be specified as: + - the string 'y' optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) Returns ------- diff --git a/plotly/graph_objs/bar/_error_x.py b/plotly/graph_objs/bar/_error_x.py index f28208c010e..6c2537e68b3 100644 --- a/plotly/graph_objs/bar/_error_x.py +++ b/plotly/graph_objs/bar/_error_x.py @@ -127,8 +127,8 @@ def color(self, val): @property def copy_ystyle(self): """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) + The 'copy_ystyle' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -283,8 +283,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/bar/_error_y.py b/plotly/graph_objs/bar/_error_y.py index e5db21fb02f..3d99cd85f2d 100644 --- a/plotly/graph_objs/bar/_error_y.py +++ b/plotly/graph_objs/bar/_error_y.py @@ -130,8 +130,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -266,8 +266,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/bar/_hoverlabel.py b/plotly/graph_objs/bar/_hoverlabel.py index 65a861ec09a..652f3069e91 100644 --- a/plotly/graph_objs/bar/_hoverlabel.py +++ b/plotly/graph_objs/bar/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/bar/_marker.py b/plotly/graph_objs/bar/_marker.py index a80880ea56a..a1fc12688db 100644 --- a/plotly/graph_objs/bar/_marker.py +++ b/plotly/graph_objs/bar/_marker.py @@ -39,8 +39,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -62,8 +62,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -178,9 +178,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -387,8 +387,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -407,8 +407,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/bar/marker/_colorbar.py b/plotly/graph_objs/bar/marker/_colorbar.py index 34223422186..f00a4bdce6e 100644 --- a/plotly/graph_objs/bar/marker/_colorbar.py +++ b/plotly/graph_objs/bar/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/bar/marker/_line.py b/plotly/graph_objs/bar/marker/_line.py index f9d515b061d..16afb497a21 100644 --- a/plotly/graph_objs/bar/marker/_line.py +++ b/plotly/graph_objs/bar/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py index 04819a0a8c8..da1b3e8501d 100644 --- a/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/barpolar/_hoverlabel.py b/plotly/graph_objs/barpolar/_hoverlabel.py index 8951184d126..b528ce3f800 100644 --- a/plotly/graph_objs/barpolar/_hoverlabel.py +++ b/plotly/graph_objs/barpolar/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/barpolar/_marker.py b/plotly/graph_objs/barpolar/_marker.py index 5015e40df15..97977f391ac 100644 --- a/plotly/graph_objs/barpolar/_marker.py +++ b/plotly/graph_objs/barpolar/_marker.py @@ -38,8 +38,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -61,8 +61,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -177,9 +177,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -365,8 +365,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -385,8 +385,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/barpolar/marker/_colorbar.py b/plotly/graph_objs/barpolar/marker/_colorbar.py index b6fef8438df..c95f81224bb 100644 --- a/plotly/graph_objs/barpolar/marker/_colorbar.py +++ b/plotly/graph_objs/barpolar/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/barpolar/marker/_line.py b/plotly/graph_objs/barpolar/marker/_line.py index 9449d2265ec..6df343506da 100644 --- a/plotly/graph_objs/barpolar/marker/_line.py +++ b/plotly/graph_objs/barpolar/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py index c860e690faa..44f0fd6bee5 100644 --- a/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/box/_hoverlabel.py b/plotly/graph_objs/box/_hoverlabel.py index aaf15bfd848..6955298406e 100644 --- a/plotly/graph_objs/box/_hoverlabel.py +++ b/plotly/graph_objs/box/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/candlestick/_hoverlabel.py b/plotly/graph_objs/candlestick/_hoverlabel.py index e8a6ecb993a..6208c5d8596 100644 --- a/plotly/graph_objs/candlestick/_hoverlabel.py +++ b/plotly/graph_objs/candlestick/_hoverlabel.py @@ -216,8 +216,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -236,8 +236,8 @@ def split(self): labels, rather than a single unified label. Default: False. When set to True, `hovertemplate` is ignored. - The 'split' property must be specified as a bool - (either True, or False) + The 'split' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/carpet/_aaxis.py b/plotly/graph_objs/carpet/_aaxis.py index 72a3cb0dc69..978ff2da310 100644 --- a/plotly/graph_objs/carpet/_aaxis.py +++ b/plotly/graph_objs/carpet/_aaxis.py @@ -286,8 +286,8 @@ def endline(self): value of this axis. If True, the end line is drawn on top of the grid lines. - The 'endline' property must be specified as a bool - (either True, or False) + The 'endline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -368,8 +368,8 @@ def fixedrange(self): Determines whether or not this axis is zoom-able. If true, then zoom is disabled. - The 'fixedrange' property must be specified as a bool - (either True, or False) + The 'fixedrange' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -744,8 +744,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -785,8 +785,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -803,8 +803,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -900,8 +900,8 @@ def startline(self): value of this axis. If True, the start line is drawn on top of the grid lines. - The 'startline' property must be specified as a bool - (either True, or False) + The 'startline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/carpet/_baxis.py b/plotly/graph_objs/carpet/_baxis.py index 28f19e7e459..4b193f8b9cc 100644 --- a/plotly/graph_objs/carpet/_baxis.py +++ b/plotly/graph_objs/carpet/_baxis.py @@ -286,8 +286,8 @@ def endline(self): value of this axis. If True, the end line is drawn on top of the grid lines. - The 'endline' property must be specified as a bool - (either True, or False) + The 'endline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -368,8 +368,8 @@ def fixedrange(self): Determines whether or not this axis is zoom-able. If true, then zoom is disabled. - The 'fixedrange' property must be specified as a bool - (either True, or False) + The 'fixedrange' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -744,8 +744,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -785,8 +785,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -803,8 +803,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -900,8 +900,8 @@ def startline(self): value of this axis. If True, the start line is drawn on top of the grid lines. - The 'startline' property must be specified as a bool - (either True, or False) + The 'startline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/carpet/aaxis/_tickformatstop.py b/plotly/graph_objs/carpet/aaxis/_tickformatstop.py index 5a757beda51..a44be5f1709 100644 --- a/plotly/graph_objs/carpet/aaxis/_tickformatstop.py +++ b/plotly/graph_objs/carpet/aaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/carpet/baxis/_tickformatstop.py b/plotly/graph_objs/carpet/baxis/_tickformatstop.py index f034d3cb101..e477d01bbe4 100644 --- a/plotly/graph_objs/carpet/baxis/_tickformatstop.py +++ b/plotly/graph_objs/carpet/baxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choropleth/_colorbar.py b/plotly/graph_objs/choropleth/_colorbar.py index ae1cbc61151..40aa56437a4 100644 --- a/plotly/graph_objs/choropleth/_colorbar.py +++ b/plotly/graph_objs/choropleth/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choropleth/_hoverlabel.py b/plotly/graph_objs/choropleth/_hoverlabel.py index 4ff4c99744a..0c7a22282ed 100644 --- a/plotly/graph_objs/choropleth/_hoverlabel.py +++ b/plotly/graph_objs/choropleth/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py b/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py index 63aa29c2b0c..6ffb5563d04 100644 --- a/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choroplethmap/_colorbar.py b/plotly/graph_objs/choroplethmap/_colorbar.py index 889cb0e97d8..a09c2a27148 100644 --- a/plotly/graph_objs/choroplethmap/_colorbar.py +++ b/plotly/graph_objs/choroplethmap/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choroplethmap/_hoverlabel.py b/plotly/graph_objs/choroplethmap/_hoverlabel.py index 5693c30f998..c1d92e41695 100644 --- a/plotly/graph_objs/choroplethmap/_hoverlabel.py +++ b/plotly/graph_objs/choroplethmap/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py b/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py index f13d83f6101..95d8ef0d3bd 100644 --- a/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choroplethmapbox/_colorbar.py b/plotly/graph_objs/choroplethmapbox/_colorbar.py index c0f6f656eb6..b5df84e382f 100644 --- a/plotly/graph_objs/choroplethmapbox/_colorbar.py +++ b/plotly/graph_objs/choroplethmapbox/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choroplethmapbox/_hoverlabel.py b/plotly/graph_objs/choroplethmapbox/_hoverlabel.py index a6d7c2cd23a..80cd197708b 100644 --- a/plotly/graph_objs/choroplethmapbox/_hoverlabel.py +++ b/plotly/graph_objs/choroplethmapbox/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py b/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py index 30794def8c9..8a0c64df381 100644 --- a/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/cone/_colorbar.py b/plotly/graph_objs/cone/_colorbar.py index 3f9dd307992..5433bc9def6 100644 --- a/plotly/graph_objs/cone/_colorbar.py +++ b/plotly/graph_objs/cone/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/cone/_hoverlabel.py b/plotly/graph_objs/cone/_hoverlabel.py index 1ac726a5a1e..efc8c36cae1 100644 --- a/plotly/graph_objs/cone/_hoverlabel.py +++ b/plotly/graph_objs/cone/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/cone/colorbar/_tickformatstop.py b/plotly/graph_objs/cone/colorbar/_tickformatstop.py index 740f3902ebb..c13e2bde6e6 100644 --- a/plotly/graph_objs/cone/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/cone/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/contour/_colorbar.py b/plotly/graph_objs/contour/_colorbar.py index 401f6eac713..f51584db162 100644 --- a/plotly/graph_objs/contour/_colorbar.py +++ b/plotly/graph_objs/contour/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/contour/_contours.py b/plotly/graph_objs/contour/_contours.py index 841169d8775..6668dbcc7c2 100644 --- a/plotly/graph_objs/contour/_contours.py +++ b/plotly/graph_objs/contour/_contours.py @@ -142,8 +142,8 @@ def showlabels(self): Determines whether to label the contour lines with their values. - The 'showlabels' property must be specified as a bool - (either True, or False) + The 'showlabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -161,8 +161,8 @@ def showlines(self): Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill". - The 'showlines' property must be specified as a bool - (either True, or False) + The 'showlines' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/contour/_hoverlabel.py b/plotly/graph_objs/contour/_hoverlabel.py index a18bfdae3dd..7a5d88b7b6c 100644 --- a/plotly/graph_objs/contour/_hoverlabel.py +++ b/plotly/graph_objs/contour/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/contour/colorbar/_tickformatstop.py b/plotly/graph_objs/contour/colorbar/_tickformatstop.py index 3ec4bfd9d98..fdc0599730b 100644 --- a/plotly/graph_objs/contour/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/contour/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/contourcarpet/_colorbar.py b/plotly/graph_objs/contourcarpet/_colorbar.py index 958feb5f9ad..5c18bab1647 100644 --- a/plotly/graph_objs/contourcarpet/_colorbar.py +++ b/plotly/graph_objs/contourcarpet/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/contourcarpet/_contours.py b/plotly/graph_objs/contourcarpet/_contours.py index cf84e8cd541..86a7e221a4b 100644 --- a/plotly/graph_objs/contourcarpet/_contours.py +++ b/plotly/graph_objs/contourcarpet/_contours.py @@ -141,8 +141,8 @@ def showlabels(self): Determines whether to label the contour lines with their values. - The 'showlabels' property must be specified as a bool - (either True, or False) + The 'showlabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -160,8 +160,8 @@ def showlines(self): Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill". - The 'showlines' property must be specified as a bool - (either True, or False) + The 'showlines' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py b/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py index e62f40968ef..3a483fa6eec 100644 --- a/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/densitymap/_colorbar.py b/plotly/graph_objs/densitymap/_colorbar.py index ed91fe4e52a..a50be1e8af4 100644 --- a/plotly/graph_objs/densitymap/_colorbar.py +++ b/plotly/graph_objs/densitymap/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/densitymap/_hoverlabel.py b/plotly/graph_objs/densitymap/_hoverlabel.py index f5726e2577e..a24156ea3ef 100644 --- a/plotly/graph_objs/densitymap/_hoverlabel.py +++ b/plotly/graph_objs/densitymap/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py b/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py index ec189ab8af9..0bb2c0ff505 100644 --- a/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/densitymapbox/_colorbar.py b/plotly/graph_objs/densitymapbox/_colorbar.py index 758ea24a0ea..d1a2f791c93 100644 --- a/plotly/graph_objs/densitymapbox/_colorbar.py +++ b/plotly/graph_objs/densitymapbox/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/densitymapbox/_hoverlabel.py b/plotly/graph_objs/densitymapbox/_hoverlabel.py index cd081870c31..c026e0bf01f 100644 --- a/plotly/graph_objs/densitymapbox/_hoverlabel.py +++ b/plotly/graph_objs/densitymapbox/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py b/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py index e81db359538..c22587b0b8e 100644 --- a/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/funnel/_connector.py b/plotly/graph_objs/funnel/_connector.py index c19f43133bb..3728c33e63b 100644 --- a/plotly/graph_objs/funnel/_connector.py +++ b/plotly/graph_objs/funnel/_connector.py @@ -56,8 +56,8 @@ def visible(self): """ Determines if connector regions and lines are drawn. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/funnel/_hoverlabel.py b/plotly/graph_objs/funnel/_hoverlabel.py index 8b732262e50..1ae4dadae04 100644 --- a/plotly/graph_objs/funnel/_hoverlabel.py +++ b/plotly/graph_objs/funnel/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/funnel/_marker.py b/plotly/graph_objs/funnel/_marker.py index 631cc28fdb3..88774bd8c5b 100644 --- a/plotly/graph_objs/funnel/_marker.py +++ b/plotly/graph_objs/funnel/_marker.py @@ -37,8 +37,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -60,8 +60,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -176,9 +176,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -343,8 +343,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -363,8 +363,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/funnel/marker/_colorbar.py b/plotly/graph_objs/funnel/marker/_colorbar.py index 85eb92a0a50..3a5d33c3883 100644 --- a/plotly/graph_objs/funnel/marker/_colorbar.py +++ b/plotly/graph_objs/funnel/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/funnel/marker/_line.py b/plotly/graph_objs/funnel/marker/_line.py index 3131fba5797..b1ecca569a5 100644 --- a/plotly/graph_objs/funnel/marker/_line.py +++ b/plotly/graph_objs/funnel/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py index 65a16937599..6653e69d985 100644 --- a/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/funnelarea/_hoverlabel.py b/plotly/graph_objs/funnelarea/_hoverlabel.py index c11fbebb040..f43eefaac06 100644 --- a/plotly/graph_objs/funnelarea/_hoverlabel.py +++ b/plotly/graph_objs/funnelarea/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/heatmap/_colorbar.py b/plotly/graph_objs/heatmap/_colorbar.py index eb3daec14e4..aca204d457c 100644 --- a/plotly/graph_objs/heatmap/_colorbar.py +++ b/plotly/graph_objs/heatmap/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/heatmap/_hoverlabel.py b/plotly/graph_objs/heatmap/_hoverlabel.py index 1eb4fb94369..9e12a018237 100644 --- a/plotly/graph_objs/heatmap/_hoverlabel.py +++ b/plotly/graph_objs/heatmap/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py b/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py index 3055e0725a0..910edda3d06 100644 --- a/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/_cumulative.py b/plotly/graph_objs/histogram/_cumulative.py index 07994807317..e06ede1f6c1 100644 --- a/plotly/graph_objs/histogram/_cumulative.py +++ b/plotly/graph_objs/histogram/_cumulative.py @@ -67,8 +67,8 @@ def enabled(self): the number of data points, and "probability" and *probability density* both rise to the number of sample points. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/_error_x.py b/plotly/graph_objs/histogram/_error_x.py index 0f51b632c33..d9d418e3b03 100644 --- a/plotly/graph_objs/histogram/_error_x.py +++ b/plotly/graph_objs/histogram/_error_x.py @@ -127,8 +127,8 @@ def color(self, val): @property def copy_ystyle(self): """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) + The 'copy_ystyle' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -283,8 +283,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/_error_y.py b/plotly/graph_objs/histogram/_error_y.py index 9c33cf16967..e37b0d95cac 100644 --- a/plotly/graph_objs/histogram/_error_y.py +++ b/plotly/graph_objs/histogram/_error_y.py @@ -130,8 +130,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -266,8 +266,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/_hoverlabel.py b/plotly/graph_objs/histogram/_hoverlabel.py index 4ee7f20e8ab..181b86c82e8 100644 --- a/plotly/graph_objs/histogram/_hoverlabel.py +++ b/plotly/graph_objs/histogram/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/_marker.py b/plotly/graph_objs/histogram/_marker.py index 4606fa66020..6f8a4ee8b76 100644 --- a/plotly/graph_objs/histogram/_marker.py +++ b/plotly/graph_objs/histogram/_marker.py @@ -39,8 +39,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -62,8 +62,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -178,9 +178,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -387,8 +387,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -407,8 +407,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/marker/_colorbar.py b/plotly/graph_objs/histogram/marker/_colorbar.py index a72fa3e899a..736ad46764b 100644 --- a/plotly/graph_objs/histogram/marker/_colorbar.py +++ b/plotly/graph_objs/histogram/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/marker/_line.py b/plotly/graph_objs/histogram/marker/_line.py index d236c0e228a..d1eaa9f732c 100644 --- a/plotly/graph_objs/histogram/marker/_line.py +++ b/plotly/graph_objs/histogram/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py index b3fda127621..e79099e9e7a 100644 --- a/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram2d/_colorbar.py b/plotly/graph_objs/histogram2d/_colorbar.py index 93cfe3683b9..2d154c94ef4 100644 --- a/plotly/graph_objs/histogram2d/_colorbar.py +++ b/plotly/graph_objs/histogram2d/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram2d/_hoverlabel.py b/plotly/graph_objs/histogram2d/_hoverlabel.py index f7cc584290e..1992a00d2d7 100644 --- a/plotly/graph_objs/histogram2d/_hoverlabel.py +++ b/plotly/graph_objs/histogram2d/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py index b6cf996db07..c5de7a7f998 100644 --- a/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram2dcontour/_colorbar.py b/plotly/graph_objs/histogram2dcontour/_colorbar.py index 2331dc3b037..8f286c2f921 100644 --- a/plotly/graph_objs/histogram2dcontour/_colorbar.py +++ b/plotly/graph_objs/histogram2dcontour/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram2dcontour/_contours.py b/plotly/graph_objs/histogram2dcontour/_contours.py index dff878cf44b..3ba60716af1 100644 --- a/plotly/graph_objs/histogram2dcontour/_contours.py +++ b/plotly/graph_objs/histogram2dcontour/_contours.py @@ -142,8 +142,8 @@ def showlabels(self): Determines whether to label the contour lines with their values. - The 'showlabels' property must be specified as a bool - (either True, or False) + The 'showlabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -161,8 +161,8 @@ def showlines(self): Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to "fill". - The 'showlines' property must be specified as a bool - (either True, or False) + The 'showlines' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram2dcontour/_hoverlabel.py b/plotly/graph_objs/histogram2dcontour/_hoverlabel.py index a9a15ede220..907db44d7d9 100644 --- a/plotly/graph_objs/histogram2dcontour/_hoverlabel.py +++ b/plotly/graph_objs/histogram2dcontour/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py index 1dba319b5b0..29a54de99ec 100644 --- a/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/icicle/_hoverlabel.py b/plotly/graph_objs/icicle/_hoverlabel.py index fc2be7a6f62..0fadea6a887 100644 --- a/plotly/graph_objs/icicle/_hoverlabel.py +++ b/plotly/graph_objs/icicle/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/icicle/_marker.py b/plotly/graph_objs/icicle/_marker.py index 15330a6202e..10bbf6cd64b 100644 --- a/plotly/graph_objs/icicle/_marker.py +++ b/plotly/graph_objs/icicle/_marker.py @@ -36,8 +36,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -58,8 +58,8 @@ def cauto(self): set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -144,9 +144,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -314,8 +314,8 @@ def reversescale(self): correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -334,8 +334,8 @@ def showscale(self): trace. Has an effect only if colors is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/icicle/_pathbar.py b/plotly/graph_objs/icicle/_pathbar.py index 828c24f9094..edc657baa12 100644 --- a/plotly/graph_objs/icicle/_pathbar.py +++ b/plotly/graph_objs/icicle/_pathbar.py @@ -97,8 +97,8 @@ def visible(self): Determines if the path bar is drawn i.e. outside the trace `domain` and with one pixel gap. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/icicle/marker/_colorbar.py b/plotly/graph_objs/icicle/marker/_colorbar.py index e64ebed666c..5ea9b15a76d 100644 --- a/plotly/graph_objs/icicle/marker/_colorbar.py +++ b/plotly/graph_objs/icicle/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py index 1cdf63f4e4c..d3148d995ce 100644 --- a/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/image/_hoverlabel.py b/plotly/graph_objs/image/_hoverlabel.py index 2b45274c461..0dc3ec89268 100644 --- a/plotly/graph_objs/image/_hoverlabel.py +++ b/plotly/graph_objs/image/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/indicator/_delta.py b/plotly/graph_objs/indicator/_delta.py index 97ff3e1071a..6c40ef637eb 100644 --- a/plotly/graph_objs/indicator/_delta.py +++ b/plotly/graph_objs/indicator/_delta.py @@ -141,8 +141,8 @@ def relative(self): """ Show relative change - The 'relative' property must be specified as a bool - (either True, or False) + The 'relative' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/indicator/gauge/_axis.py b/plotly/graph_objs/indicator/gauge/_axis.py index 79207742bfb..118be6f7b36 100644 --- a/plotly/graph_objs/indicator/gauge/_axis.py +++ b/plotly/graph_objs/indicator/gauge/_axis.py @@ -199,8 +199,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -239,8 +239,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -680,8 +680,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py b/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py index d9f8c191d05..6f4d7b56762 100644 --- a/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py +++ b/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/_colorbar.py b/plotly/graph_objs/isosurface/_colorbar.py index 2b4807a8e1f..9faba4c3cd3 100644 --- a/plotly/graph_objs/isosurface/_colorbar.py +++ b/plotly/graph_objs/isosurface/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/_contour.py b/plotly/graph_objs/isosurface/_contour.py index 9032da23c40..abd067d5c52 100644 --- a/plotly/graph_objs/isosurface/_contour.py +++ b/plotly/graph_objs/isosurface/_contour.py @@ -37,8 +37,8 @@ def show(self): """ Sets whether or not dynamic contours are shown on hover - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/_hoverlabel.py b/plotly/graph_objs/isosurface/_hoverlabel.py index 88a640e8c4a..7328d3be35b 100644 --- a/plotly/graph_objs/isosurface/_hoverlabel.py +++ b/plotly/graph_objs/isosurface/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/_spaceframe.py b/plotly/graph_objs/isosurface/_spaceframe.py index 8aa7d75e991..9bbe302d2aa 100644 --- a/plotly/graph_objs/isosurface/_spaceframe.py +++ b/plotly/graph_objs/isosurface/_spaceframe.py @@ -39,8 +39,8 @@ def show(self): iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/_surface.py b/plotly/graph_objs/isosurface/_surface.py index 605e7fd84b2..9f28e9a2976 100644 --- a/plotly/graph_objs/isosurface/_surface.py +++ b/plotly/graph_objs/isosurface/_surface.py @@ -84,8 +84,8 @@ def show(self): """ Hides/displays surfaces between minimum and maximum iso-values. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/caps/_x.py b/plotly/graph_objs/isosurface/caps/_x.py index c93cb6de149..fd10b7e7bef 100644 --- a/plotly/graph_objs/isosurface/caps/_x.py +++ b/plotly/graph_objs/isosurface/caps/_x.py @@ -39,8 +39,8 @@ def show(self): the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/caps/_y.py b/plotly/graph_objs/isosurface/caps/_y.py index fe3a13ea482..ae17f7f51d1 100644 --- a/plotly/graph_objs/isosurface/caps/_y.py +++ b/plotly/graph_objs/isosurface/caps/_y.py @@ -39,8 +39,8 @@ def show(self): the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/caps/_z.py b/plotly/graph_objs/isosurface/caps/_z.py index b60831e0833..e7516c99bd7 100644 --- a/plotly/graph_objs/isosurface/caps/_z.py +++ b/plotly/graph_objs/isosurface/caps/_z.py @@ -39,8 +39,8 @@ def show(self): the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py b/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py index faa7b68c212..b6f7295c858 100644 --- a/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/slices/_x.py b/plotly/graph_objs/isosurface/slices/_x.py index a47a8f9f6b6..9aa0648a240 100644 --- a/plotly/graph_objs/isosurface/slices/_x.py +++ b/plotly/graph_objs/isosurface/slices/_x.py @@ -76,8 +76,8 @@ def show(self): Determines whether or not slice planes about the x dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/slices/_y.py b/plotly/graph_objs/isosurface/slices/_y.py index 29e54ef2f63..b775a1bb4a7 100644 --- a/plotly/graph_objs/isosurface/slices/_y.py +++ b/plotly/graph_objs/isosurface/slices/_y.py @@ -76,8 +76,8 @@ def show(self): Determines whether or not slice planes about the y dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/isosurface/slices/_z.py b/plotly/graph_objs/isosurface/slices/_z.py index 2aa0012ac84..b554acb5075 100644 --- a/plotly/graph_objs/isosurface/slices/_z.py +++ b/plotly/graph_objs/isosurface/slices/_z.py @@ -76,8 +76,8 @@ def show(self): Determines whether or not slice planes about the z dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_annotation.py b/plotly/graph_objs/layout/_annotation.py index d06b1061141..981373d9f53 100644 --- a/plotly/graph_objs/layout/_annotation.py +++ b/plotly/graph_objs/layout/_annotation.py @@ -392,8 +392,8 @@ def captureevents(self): provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`. - The 'captureevents' property must be specified as a bool - (either True, or False) + The 'captureevents' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -564,8 +564,8 @@ def showarrow(self): 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) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -756,8 +756,8 @@ def visible(self): """ Determines whether or not this annotation is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_coloraxis.py b/plotly/graph_objs/layout/_coloraxis.py index 4606c7add93..0b4ec2edad6 100644 --- a/plotly/graph_objs/layout/_coloraxis.py +++ b/plotly/graph_objs/layout/_coloraxis.py @@ -30,8 +30,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -51,8 +51,8 @@ def cauto(self): array(s)) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -202,8 +202,8 @@ def reversescale(self): correspond to the last color in the array and `cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -221,8 +221,8 @@ 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) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_geo.py b/plotly/graph_objs/layout/_geo.py index 43b49a8ad07..bee07ae6512 100644 --- a/plotly/graph_objs/layout/_geo.py +++ b/plotly/graph_objs/layout/_geo.py @@ -463,8 +463,8 @@ def showcoastlines(self): """ Sets whether or not the coastlines are drawn. - The 'showcoastlines' property must be specified as a bool - (either True, or False) + The 'showcoastlines' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -481,8 +481,8 @@ def showcountries(self): """ Sets whether or not country boundaries are drawn. - The 'showcountries' property must be specified as a bool - (either True, or False) + The 'showcountries' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -499,8 +499,8 @@ def showframe(self): """ Sets whether or not a frame is drawn around the map. - The 'showframe' property must be specified as a bool - (either True, or False) + The 'showframe' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -517,8 +517,8 @@ def showlakes(self): """ Sets whether or not lakes are drawn. - The 'showlakes' property must be specified as a bool - (either True, or False) + The 'showlakes' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -535,8 +535,8 @@ def showland(self): """ Sets whether or not land masses are filled in color. - The 'showland' property must be specified as a bool - (either True, or False) + The 'showland' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -553,8 +553,8 @@ def showocean(self): """ Sets whether or not oceans are filled in color. - The 'showocean' property must be specified as a bool - (either True, or False) + The 'showocean' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -571,8 +571,8 @@ def showrivers(self): """ Sets whether or not rivers are drawn. - The 'showrivers' property must be specified as a bool - (either True, or False) + The 'showrivers' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -590,8 +590,8 @@ def showsubunits(self): Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn. - The 'showsubunits' property must be specified as a bool - (either True, or False) + The 'showsubunits' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -666,8 +666,8 @@ def visible(self): """ Sets the default visibility of the base layers. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_hoverlabel.py b/plotly/graph_objs/layout/_hoverlabel.py index a65ee1b2722..644ed5469b4 100644 --- a/plotly/graph_objs/layout/_hoverlabel.py +++ b/plotly/graph_objs/layout/_hoverlabel.py @@ -157,8 +157,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_image.py b/plotly/graph_objs/layout/_image.py index 33865e42ac6..943ff247797 100644 --- a/plotly/graph_objs/layout/_image.py +++ b/plotly/graph_objs/layout/_image.py @@ -210,8 +210,8 @@ def visible(self): """ Determines whether or not this image is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_legend.py b/plotly/graph_objs/layout/_legend.py index 39b75b0a378..618f90f3afc 100644 --- a/plotly/graph_objs/layout/_legend.py +++ b/plotly/graph_objs/layout/_legend.py @@ -462,8 +462,8 @@ def visible(self): """ Determines whether or not this legend is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_margin.py b/plotly/graph_objs/layout/_margin.py index 2af604870c7..b574b3f9f4e 100644 --- a/plotly/graph_objs/layout/_margin.py +++ b/plotly/graph_objs/layout/_margin.py @@ -17,8 +17,8 @@ def autoexpand(self): updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults. - The 'autoexpand' property must be specified as a bool - (either True, or False) + The 'autoexpand' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_newshape.py b/plotly/graph_objs/layout/_newshape.py index 05710a14563..269a2586647 100644 --- a/plotly/graph_objs/layout/_newshape.py +++ b/plotly/graph_objs/layout/_newshape.py @@ -145,9 +145,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -301,8 +301,8 @@ def showlegend(self): """ Determines whether or not new shape is shown in the legend. - The 'showlegend' property must be specified as a bool - (either True, or False) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_shape.py b/plotly/graph_objs/layout/_shape.py index 8923d1c172f..480bfa440bf 100644 --- a/plotly/graph_objs/layout/_shape.py +++ b/plotly/graph_objs/layout/_shape.py @@ -50,8 +50,8 @@ def editable(self): not. Has no effect when the older editable shapes mode is enabled via `config.editable` or `config.edits.shapePosition`. - The 'editable' property must be specified as a bool - (either True, or False) + The 'editable' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -157,9 +157,9 @@ def legend(self): `layout.legend`, `layout.legend2`, etc. The 'legend' property is an identifier of a particular - subplot, of type 'legend', that may be specified as the string 'legend' - optionally followed by an integer >= 1 - (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + subplot, of type 'legend', that may be specified as: + - the string 'legend' optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) Returns ------- @@ -359,8 +359,8 @@ def showlegend(self): """ Determines whether or not this shape is shown in the legend. - The 'showlegend' property must be specified as a bool - (either True, or False) + The 'showlegend' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_slider.py b/plotly/graph_objs/layout/_slider.py index e6d0a2fe24b..cfafd247901 100644 --- a/plotly/graph_objs/layout/_slider.py +++ b/plotly/graph_objs/layout/_slider.py @@ -432,8 +432,8 @@ def visible(self): """ Determines whether or not the slider is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_title.py b/plotly/graph_objs/layout/_title.py index 47301d8e114..379ed507d6d 100644 --- a/plotly/graph_objs/layout/_title.py +++ b/plotly/graph_objs/layout/_title.py @@ -37,8 +37,8 @@ def automargin(self): allowed y values. Invalid values will be reset to the default 1. - The 'automargin' property must be specified as a bool - (either True, or False) + The 'automargin' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_updatemenu.py b/plotly/graph_objs/layout/_updatemenu.py index ebd1e679381..fe5abd7960e 100644 --- a/plotly/graph_objs/layout/_updatemenu.py +++ b/plotly/graph_objs/layout/_updatemenu.py @@ -248,8 +248,8 @@ def showactive(self): """ Highlights active dropdown item or active button if true. - The 'showactive' property must be specified as a bool - (either True, or False) + The 'showactive' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -313,8 +313,8 @@ def visible(self): """ Determines whether or not the update menu is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_xaxis.py b/plotly/graph_objs/layout/_xaxis.py index df89fd8ed06..a146cb6898a 100644 --- a/plotly/graph_objs/layout/_xaxis.py +++ b/plotly/graph_objs/layout/_xaxis.py @@ -558,8 +558,8 @@ def fixedrange(self): Determines whether or not this axis is zoom-able. If true, then zoom is disabled. - The 'fixedrange' property must be specified as a bool - (either True, or False) + The 'fixedrange' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1216,8 +1216,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1236,8 +1236,8 @@ def showdividers(self): category levels of this axis. Only has an effect on "multicategory" axes. - The 'showdividers' property must be specified as a bool - (either True, or False) + The 'showdividers' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1277,8 +1277,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1295,8 +1295,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1315,8 +1315,8 @@ def showspikes(self): this axis. Note: This only takes affect when hovermode = closest - The 'showspikes' property must be specified as a bool - (either True, or False) + The 'showspikes' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1333,8 +1333,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -2171,8 +2171,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -2191,8 +2191,8 @@ def zeroline(self): of this axis. If True, the zero line is drawn on top of the grid lines. - The 'zeroline' property must be specified as a bool - (either True, or False) + The 'zeroline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/_yaxis.py b/plotly/graph_objs/layout/_yaxis.py index 8406200c877..4e81f347a4e 100644 --- a/plotly/graph_objs/layout/_yaxis.py +++ b/plotly/graph_objs/layout/_yaxis.py @@ -211,8 +211,8 @@ def autoshift(self): same side with `autoshift` is set to true. Only has an effect if `anchor` is set to "free". - The 'autoshift' property must be specified as a bool - (either True, or False) + The 'autoshift' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -580,8 +580,8 @@ def fixedrange(self): Determines whether or not this axis is zoom-able. If true, then zoom is disabled. - The 'fixedrange' property must be specified as a bool - (either True, or False) + The 'fixedrange' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1200,8 +1200,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1244,8 +1244,8 @@ def showdividers(self): category levels of this axis. Only has an effect on "multicategory" axes. - The 'showdividers' property must be specified as a bool - (either True, or False) + The 'showdividers' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1285,8 +1285,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1303,8 +1303,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1323,8 +1323,8 @@ def showspikes(self): this axis. Note: This only takes affect when hovermode = closest - The 'showspikes' property must be specified as a bool - (either True, or False) + The 'showspikes' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1341,8 +1341,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -2179,8 +2179,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -2199,8 +2199,8 @@ def zeroline(self): of this axis. If True, the zero line is drawn on top of the grid lines. - The 'zeroline' property must be specified as a bool - (either True, or False) + The 'zeroline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/coloraxis/_colorbar.py b/plotly/graph_objs/layout/coloraxis/_colorbar.py index 15aa2821b0e..bbab216a7ef 100644 --- a/plotly/graph_objs/layout/coloraxis/_colorbar.py +++ b/plotly/graph_objs/layout/coloraxis/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py b/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py index 2a971e117ef..dde3ae030ee 100644 --- a/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/geo/_lataxis.py b/plotly/graph_objs/layout/geo/_lataxis.py index fcaf4c85466..dd66e0e354d 100644 --- a/plotly/graph_objs/layout/geo/_lataxis.py +++ b/plotly/graph_objs/layout/geo/_lataxis.py @@ -129,8 +129,8 @@ def showgrid(self): """ Sets whether or not graticule are shown on the map. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/geo/_lonaxis.py b/plotly/graph_objs/layout/geo/_lonaxis.py index 6b3152774c2..731b8a5f814 100644 --- a/plotly/graph_objs/layout/geo/_lonaxis.py +++ b/plotly/graph_objs/layout/geo/_lonaxis.py @@ -129,8 +129,8 @@ def showgrid(self): """ Sets whether or not graticule are shown on the map. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/map/_layer.py b/plotly/graph_objs/layout/map/_layer.py index 47ef55dd2d5..dc4f067c149 100644 --- a/plotly/graph_objs/layout/map/_layer.py +++ b/plotly/graph_objs/layout/map/_layer.py @@ -400,8 +400,8 @@ def visible(self): """ Determines whether this layer is displayed - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/mapbox/_layer.py b/plotly/graph_objs/layout/mapbox/_layer.py index c942adbc288..2380f6aadaf 100644 --- a/plotly/graph_objs/layout/mapbox/_layer.py +++ b/plotly/graph_objs/layout/mapbox/_layer.py @@ -402,8 +402,8 @@ def visible(self): """ Determines whether this layer is displayed - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/polar/_angularaxis.py b/plotly/graph_objs/layout/polar/_angularaxis.py index 1bf57dfd0f1..d63eba9731d 100644 --- a/plotly/graph_objs/layout/polar/_angularaxis.py +++ b/plotly/graph_objs/layout/polar/_angularaxis.py @@ -562,8 +562,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -603,8 +603,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -621,8 +621,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -639,8 +639,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1139,8 +1139,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/polar/_radialaxis.py b/plotly/graph_objs/layout/polar/_radialaxis.py index 6c6561621e7..4c7d4e8ee4e 100644 --- a/plotly/graph_objs/layout/polar/_radialaxis.py +++ b/plotly/graph_objs/layout/polar/_radialaxis.py @@ -714,8 +714,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -755,8 +755,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -773,8 +773,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -791,8 +791,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1310,8 +1310,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py b/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py index 8142b3c23ce..14e089e256d 100644 --- a/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py b/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py index a2c237a29d5..ec1cfb76647 100644 --- a/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/scene/_annotation.py b/plotly/graph_objs/layout/scene/_annotation.py index ba367344d6c..a4e9043ecc6 100644 --- a/plotly/graph_objs/layout/scene/_annotation.py +++ b/plotly/graph_objs/layout/scene/_annotation.py @@ -300,8 +300,8 @@ def captureevents(self): provided. If you use the event `plotly_clickannotation` without `hovertext` you must explicitly enable `captureevents`. - The 'captureevents' property must be specified as a bool - (either True, or False) + The 'captureevents' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -442,8 +442,8 @@ def showarrow(self): 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) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -634,8 +634,8 @@ def visible(self): """ Determines whether or not this annotation is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/scene/_xaxis.py b/plotly/graph_objs/layout/scene/_xaxis.py index 2784c34df31..7d914f4645f 100644 --- a/plotly/graph_objs/layout/scene/_xaxis.py +++ b/plotly/graph_objs/layout/scene/_xaxis.py @@ -645,8 +645,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -663,8 +663,8 @@ def showaxeslabels(self): """ Sets whether or not this axis is labeled - The 'showaxeslabels' property must be specified as a bool - (either True, or False) + The 'showaxeslabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -681,8 +681,8 @@ def showbackground(self): """ Sets whether or not this axis' wall has a background color. - The 'showbackground' property must be specified as a bool - (either True, or False) + The 'showbackground' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -722,8 +722,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -740,8 +740,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -759,8 +759,8 @@ def showspikes(self): Sets whether or not spikes starting from data points to this axis' wall are shown on hover. - The 'showspikes' property must be specified as a bool - (either True, or False) + The 'showspikes' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -777,8 +777,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -859,8 +859,8 @@ def spikesides(self): Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover. - The 'spikesides' property must be specified as a bool - (either True, or False) + The 'spikesides' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1293,8 +1293,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1313,8 +1313,8 @@ def zeroline(self): of this axis. If True, the zero line is drawn on top of the grid lines. - The 'zeroline' property must be specified as a bool - (either True, or False) + The 'zeroline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/scene/_yaxis.py b/plotly/graph_objs/layout/scene/_yaxis.py index cebc6b05016..b7d95480c99 100644 --- a/plotly/graph_objs/layout/scene/_yaxis.py +++ b/plotly/graph_objs/layout/scene/_yaxis.py @@ -645,8 +645,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -663,8 +663,8 @@ def showaxeslabels(self): """ Sets whether or not this axis is labeled - The 'showaxeslabels' property must be specified as a bool - (either True, or False) + The 'showaxeslabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -681,8 +681,8 @@ def showbackground(self): """ Sets whether or not this axis' wall has a background color. - The 'showbackground' property must be specified as a bool - (either True, or False) + The 'showbackground' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -722,8 +722,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -740,8 +740,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -759,8 +759,8 @@ def showspikes(self): Sets whether or not spikes starting from data points to this axis' wall are shown on hover. - The 'showspikes' property must be specified as a bool - (either True, or False) + The 'showspikes' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -777,8 +777,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -859,8 +859,8 @@ def spikesides(self): Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover. - The 'spikesides' property must be specified as a bool - (either True, or False) + The 'spikesides' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1293,8 +1293,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1313,8 +1313,8 @@ def zeroline(self): of this axis. If True, the zero line is drawn on top of the grid lines. - The 'zeroline' property must be specified as a bool - (either True, or False) + The 'zeroline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/scene/_zaxis.py b/plotly/graph_objs/layout/scene/_zaxis.py index 7a0fb151055..db30a14f286 100644 --- a/plotly/graph_objs/layout/scene/_zaxis.py +++ b/plotly/graph_objs/layout/scene/_zaxis.py @@ -645,8 +645,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -663,8 +663,8 @@ def showaxeslabels(self): """ Sets whether or not this axis is labeled - The 'showaxeslabels' property must be specified as a bool - (either True, or False) + The 'showaxeslabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -681,8 +681,8 @@ def showbackground(self): """ Sets whether or not this axis' wall has a background color. - The 'showbackground' property must be specified as a bool - (either True, or False) + The 'showbackground' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -722,8 +722,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -740,8 +740,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -759,8 +759,8 @@ def showspikes(self): Sets whether or not spikes starting from data points to this axis' wall are shown on hover. - The 'showspikes' property must be specified as a bool - (either True, or False) + The 'showspikes' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -777,8 +777,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -859,8 +859,8 @@ def spikesides(self): Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover. - The 'spikesides' property must be specified as a bool - (either True, or False) + The 'spikesides' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1293,8 +1293,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -1313,8 +1313,8 @@ def zeroline(self): of this axis. If True, the zero line is drawn on top of the grid lines. - The 'zeroline' property must be specified as a bool - (either True, or False) + The 'zeroline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py index 8953f2c6460..f2b5efba58a 100644 --- a/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py index faf7540c066..f2fff741fbe 100644 --- a/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py index 1d6cc95c1f1..7152ac4420e 100644 --- a/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/slider/_currentvalue.py b/plotly/graph_objs/layout/slider/_currentvalue.py index d25d72bc681..4ec6371f908 100644 --- a/plotly/graph_objs/layout/slider/_currentvalue.py +++ b/plotly/graph_objs/layout/slider/_currentvalue.py @@ -95,8 +95,8 @@ def visible(self): """ Shows the currently-selected value above the slider. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/slider/_step.py b/plotly/graph_objs/layout/slider/_step.py index bcc3d92439b..ef5e6e0c022 100644 --- a/plotly/graph_objs/layout/slider/_step.py +++ b/plotly/graph_objs/layout/slider/_step.py @@ -53,8 +53,8 @@ def execute(self): binding to the state of the plot through the specification of `method` and `args`. - The 'execute' property must be specified as a bool - (either True, or False) + The 'execute' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -185,8 +185,8 @@ def visible(self): """ Determines whether or not this step is included in the slider. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/smith/_imaginaryaxis.py b/plotly/graph_objs/layout/smith/_imaginaryaxis.py index 85ae07a704a..90ab43a8f92 100644 --- a/plotly/graph_objs/layout/smith/_imaginaryaxis.py +++ b/plotly/graph_objs/layout/smith/_imaginaryaxis.py @@ -248,8 +248,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -266,8 +266,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -284,8 +284,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -548,8 +548,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/smith/_realaxis.py b/plotly/graph_objs/layout/smith/_realaxis.py index 7a3bf0e3376..0e9fc48520a 100644 --- a/plotly/graph_objs/layout/smith/_realaxis.py +++ b/plotly/graph_objs/layout/smith/_realaxis.py @@ -250,8 +250,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -268,8 +268,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -286,8 +286,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -591,8 +591,8 @@ def visible(self): like dragging. Default is true when a cheater plot is present on the axis, otherwise false - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/ternary/_aaxis.py b/plotly/graph_objs/layout/ternary/_aaxis.py index 9b7521fc734..0915f543b7a 100644 --- a/plotly/graph_objs/layout/ternary/_aaxis.py +++ b/plotly/graph_objs/layout/ternary/_aaxis.py @@ -388,8 +388,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -429,8 +429,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -447,8 +447,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -465,8 +465,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/ternary/_baxis.py b/plotly/graph_objs/layout/ternary/_baxis.py index 72ad0f499ea..300c45df413 100644 --- a/plotly/graph_objs/layout/ternary/_baxis.py +++ b/plotly/graph_objs/layout/ternary/_baxis.py @@ -388,8 +388,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -429,8 +429,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -447,8 +447,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -465,8 +465,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/ternary/_caxis.py b/plotly/graph_objs/layout/ternary/_caxis.py index 1f17d33e475..54905b7fb18 100644 --- a/plotly/graph_objs/layout/ternary/_caxis.py +++ b/plotly/graph_objs/layout/ternary/_caxis.py @@ -388,8 +388,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -429,8 +429,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -447,8 +447,8 @@ def showline(self): """ Determines whether or not a line bounding this axis is drawn. - The 'showline' property must be specified as a bool - (either True, or False) + The 'showline' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -465,8 +465,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py index e58ffb34d2d..d5633783dca 100644 --- a/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py index 7c934f9b708..5f710f3b2de 100644 --- a/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py index a0baf4db260..37296ef6daa 100644 --- a/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/updatemenu/_button.py b/plotly/graph_objs/layout/updatemenu/_button.py index 2fdb0b48cff..0c3830ff265 100644 --- a/plotly/graph_objs/layout/updatemenu/_button.py +++ b/plotly/graph_objs/layout/updatemenu/_button.py @@ -77,8 +77,8 @@ def execute(self): automatically binding to the state of the plot through the specification of `method` and `args`. - The 'execute' property must be specified as a bool - (either True, or False) + The 'execute' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -188,8 +188,8 @@ def visible(self): """ Determines whether or not this button is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/xaxis/_minor.py b/plotly/graph_objs/layout/xaxis/_minor.py index fbe8b7249aa..8a1a5aac789 100644 --- a/plotly/graph_objs/layout/xaxis/_minor.py +++ b/plotly/graph_objs/layout/xaxis/_minor.py @@ -153,8 +153,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/xaxis/_rangebreak.py b/plotly/graph_objs/layout/xaxis/_rangebreak.py index 40246fbb631..1016a1836ef 100644 --- a/plotly/graph_objs/layout/xaxis/_rangebreak.py +++ b/plotly/graph_objs/layout/xaxis/_rangebreak.py @@ -65,8 +65,8 @@ 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) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/xaxis/_rangeselector.py b/plotly/graph_objs/layout/xaxis/_rangeselector.py index 22404bc2b83..7c61c3dbb30 100644 --- a/plotly/graph_objs/layout/xaxis/_rangeselector.py +++ b/plotly/graph_objs/layout/xaxis/_rangeselector.py @@ -182,8 +182,8 @@ def visible(self): that range selectors are only available for x axes of `type` set to or auto-typed to "date". - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/xaxis/_rangeslider.py b/plotly/graph_objs/layout/xaxis/_rangeslider.py index 9d30a4d37d7..1c9e637dfec 100644 --- a/plotly/graph_objs/layout/xaxis/_rangeslider.py +++ b/plotly/graph_objs/layout/xaxis/_rangeslider.py @@ -26,8 +26,8 @@ def autorange(self): relation to the input data. If `range` is provided, then `autorange` is set to False. - The 'autorange' property must be specified as a bool - (either True, or False) + The 'autorange' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -155,8 +155,8 @@ def visible(self): Determines whether or not the range slider will be visible. If visible, perpendicular axes will be set to `fixedrange` - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/xaxis/_tickformatstop.py b/plotly/graph_objs/layout/xaxis/_tickformatstop.py index 6941096533d..5fcc6d76387 100644 --- a/plotly/graph_objs/layout/xaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/xaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/xaxis/rangeselector/_button.py b/plotly/graph_objs/layout/xaxis/rangeselector/_button.py index adfa4677348..c465fd81ec0 100644 --- a/plotly/graph_objs/layout/xaxis/rangeselector/_button.py +++ b/plotly/graph_objs/layout/xaxis/rangeselector/_button.py @@ -160,8 +160,8 @@ def visible(self): """ Determines whether or not this button is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/yaxis/_minor.py b/plotly/graph_objs/layout/yaxis/_minor.py index c718a605acc..73ced5ce933 100644 --- a/plotly/graph_objs/layout/yaxis/_minor.py +++ b/plotly/graph_objs/layout/yaxis/_minor.py @@ -153,8 +153,8 @@ def showgrid(self): Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. - The 'showgrid' property must be specified as a bool - (either True, or False) + The 'showgrid' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/yaxis/_rangebreak.py b/plotly/graph_objs/layout/yaxis/_rangebreak.py index 1816985f380..347f4678405 100644 --- a/plotly/graph_objs/layout/yaxis/_rangebreak.py +++ b/plotly/graph_objs/layout/yaxis/_rangebreak.py @@ -65,8 +65,8 @@ 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) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/layout/yaxis/_tickformatstop.py b/plotly/graph_objs/layout/yaxis/_tickformatstop.py index 40314fda7a8..b4ab134c2f6 100644 --- a/plotly/graph_objs/layout/yaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/yaxis/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/mesh3d/_colorbar.py b/plotly/graph_objs/mesh3d/_colorbar.py index 86bdabf0200..8803871da67 100644 --- a/plotly/graph_objs/mesh3d/_colorbar.py +++ b/plotly/graph_objs/mesh3d/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/mesh3d/_contour.py b/plotly/graph_objs/mesh3d/_contour.py index b55625a5413..fd831f39e53 100644 --- a/plotly/graph_objs/mesh3d/_contour.py +++ b/plotly/graph_objs/mesh3d/_contour.py @@ -37,8 +37,8 @@ def show(self): """ Sets whether or not dynamic contours are shown on hover - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/mesh3d/_hoverlabel.py b/plotly/graph_objs/mesh3d/_hoverlabel.py index 4799abdb467..7cad9294c39 100644 --- a/plotly/graph_objs/mesh3d/_hoverlabel.py +++ b/plotly/graph_objs/mesh3d/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py b/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py index bb5fe240af0..3044122b2ad 100644 --- a/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/ohlc/_hoverlabel.py b/plotly/graph_objs/ohlc/_hoverlabel.py index b9e63ef9230..c91cfbbd189 100644 --- a/plotly/graph_objs/ohlc/_hoverlabel.py +++ b/plotly/graph_objs/ohlc/_hoverlabel.py @@ -216,8 +216,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -236,8 +236,8 @@ def split(self): labels, rather than a single unified label. Default: False. When set to True, `hovertemplate` is ignored. - The 'split' property must be specified as a bool - (either True, or False) + The 'split' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcats/_dimension.py b/plotly/graph_objs/parcats/_dimension.py index 17a67da7ee3..e2bdcb60ba8 100644 --- a/plotly/graph_objs/parcats/_dimension.py +++ b/plotly/graph_objs/parcats/_dimension.py @@ -212,8 +212,8 @@ def visible(self): Shows the dimension when set to `true` (the default). Hides the dimension for `false`. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcats/_line.py b/plotly/graph_objs/parcats/_line.py index 2946fe4966c..7080c271639 100644 --- a/plotly/graph_objs/parcats/_line.py +++ b/plotly/graph_objs/parcats/_line.py @@ -37,8 +37,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -59,8 +59,8 @@ def cauto(self): `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -175,9 +175,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -352,8 +352,8 @@ def reversescale(self): will correspond to the last color in the array and `line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -393,8 +393,8 @@ def showscale(self): trace. Has an effect only if in `line.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcats/line/_colorbar.py b/plotly/graph_objs/parcats/line/_colorbar.py index 76524feec80..a5204df743b 100644 --- a/plotly/graph_objs/parcats/line/_colorbar.py +++ b/plotly/graph_objs/parcats/line/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py b/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py index fc0ffbf2c83..51c87f4d92f 100644 --- a/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcoords/_dimension.py b/plotly/graph_objs/parcoords/_dimension.py index 0c28911e144..2fff5f12e3a 100644 --- a/plotly/graph_objs/parcoords/_dimension.py +++ b/plotly/graph_objs/parcoords/_dimension.py @@ -78,8 +78,8 @@ def multiselect(self): """ Do we allow multiple selection ranges or just a single range? - The 'multiselect' property must be specified as a bool - (either True, or False) + The 'multiselect' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -312,8 +312,8 @@ def visible(self): Shows the dimension when set to `true` (the default). Hides the dimension for `false`. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcoords/_line.py b/plotly/graph_objs/parcoords/_line.py index 82478ae9b0d..5d6799395d2 100644 --- a/plotly/graph_objs/parcoords/_line.py +++ b/plotly/graph_objs/parcoords/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -56,8 +56,8 @@ def cauto(self): `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -172,9 +172,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -283,8 +283,8 @@ def reversescale(self): will correspond to the last color in the array and `line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -303,8 +303,8 @@ def showscale(self): trace. Has an effect only if in `line.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcoords/line/_colorbar.py b/plotly/graph_objs/parcoords/line/_colorbar.py index d82375c04eb..3ee4f8df995 100644 --- a/plotly/graph_objs/parcoords/line/_colorbar.py +++ b/plotly/graph_objs/parcoords/line/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py b/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py index 0cbc6452887..6bed2d5d377 100644 --- a/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/pie/_hoverlabel.py b/plotly/graph_objs/pie/_hoverlabel.py index cc540690eb0..74bdb7891a2 100644 --- a/plotly/graph_objs/pie/_hoverlabel.py +++ b/plotly/graph_objs/pie/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/sankey/_hoverlabel.py b/plotly/graph_objs/sankey/_hoverlabel.py index fdf16e60a0c..1050307088c 100644 --- a/plotly/graph_objs/sankey/_hoverlabel.py +++ b/plotly/graph_objs/sankey/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/sankey/link/_hoverlabel.py b/plotly/graph_objs/sankey/link/_hoverlabel.py index b069ccb72b6..6cf3432e27b 100644 --- a/plotly/graph_objs/sankey/link/_hoverlabel.py +++ b/plotly/graph_objs/sankey/link/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/sankey/node/_hoverlabel.py b/plotly/graph_objs/sankey/node/_hoverlabel.py index b356253006e..796199bb962 100644 --- a/plotly/graph_objs/sankey/node/_hoverlabel.py +++ b/plotly/graph_objs/sankey/node/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/_error_x.py b/plotly/graph_objs/scatter/_error_x.py index b312a56e389..1b6a774eb8f 100644 --- a/plotly/graph_objs/scatter/_error_x.py +++ b/plotly/graph_objs/scatter/_error_x.py @@ -127,8 +127,8 @@ def color(self, val): @property def copy_ystyle(self): """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) + The 'copy_ystyle' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -283,8 +283,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/_error_y.py b/plotly/graph_objs/scatter/_error_y.py index a5a8228267a..c36245dd2d3 100644 --- a/plotly/graph_objs/scatter/_error_y.py +++ b/plotly/graph_objs/scatter/_error_y.py @@ -130,8 +130,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -266,8 +266,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/_hoverlabel.py b/plotly/graph_objs/scatter/_hoverlabel.py index eebb9f77742..9789db1a0e7 100644 --- a/plotly/graph_objs/scatter/_hoverlabel.py +++ b/plotly/graph_objs/scatter/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/_line.py b/plotly/graph_objs/scatter/_line.py index 872923db544..dd4f7ec8dc7 100644 --- a/plotly/graph_objs/scatter/_line.py +++ b/plotly/graph_objs/scatter/_line.py @@ -134,8 +134,8 @@ def simplify(self): that the number of points along the resulting SVG path is unaffected. - The 'simplify' property must be specified as a bool - (either True, or False) + The 'simplify' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/_marker.py b/plotly/graph_objs/scatter/_marker.py index 3543558763a..639d5ad3a36 100644 --- a/plotly/graph_objs/scatter/_marker.py +++ b/plotly/graph_objs/scatter/_marker.py @@ -110,8 +110,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -133,8 +133,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -249,9 +249,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -454,8 +454,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -474,8 +474,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/marker/_colorbar.py b/plotly/graph_objs/scatter/marker/_colorbar.py index 2c94b45741f..ee209e4fe4f 100644 --- a/plotly/graph_objs/scatter/marker/_colorbar.py +++ b/plotly/graph_objs/scatter/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/marker/_line.py b/plotly/graph_objs/scatter/marker/_line.py index 4d77c650a6f..2ac6e608078 100644 --- a/plotly/graph_objs/scatter/marker/_line.py +++ b/plotly/graph_objs/scatter/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py index 17996eb5adc..f6b28e33dbe 100644 --- a/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/_error_x.py b/plotly/graph_objs/scatter3d/_error_x.py index 1fd5bd2af70..ed735d629c2 100644 --- a/plotly/graph_objs/scatter3d/_error_x.py +++ b/plotly/graph_objs/scatter3d/_error_x.py @@ -127,8 +127,8 @@ def color(self, val): @property def copy_zstyle(self): """ - The 'copy_zstyle' property must be specified as a bool - (either True, or False) + The 'copy_zstyle' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -283,8 +283,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/_error_y.py b/plotly/graph_objs/scatter3d/_error_y.py index 87c1a936f0d..c62ab3a17a4 100644 --- a/plotly/graph_objs/scatter3d/_error_y.py +++ b/plotly/graph_objs/scatter3d/_error_y.py @@ -127,8 +127,8 @@ def color(self, val): @property def copy_zstyle(self): """ - The 'copy_zstyle' property must be specified as a bool - (either True, or False) + The 'copy_zstyle' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -283,8 +283,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/_error_z.py b/plotly/graph_objs/scatter3d/_error_z.py index cdfd115ac7e..1fe50cd0981 100644 --- a/plotly/graph_objs/scatter3d/_error_z.py +++ b/plotly/graph_objs/scatter3d/_error_z.py @@ -130,8 +130,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -266,8 +266,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/_hoverlabel.py b/plotly/graph_objs/scatter3d/_hoverlabel.py index 7255c0f13d7..2f9bba3b0e3 100644 --- a/plotly/graph_objs/scatter3d/_hoverlabel.py +++ b/plotly/graph_objs/scatter3d/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/_line.py b/plotly/graph_objs/scatter3d/_line.py index d1d72347aa3..1f2c3c46553 100644 --- a/plotly/graph_objs/scatter3d/_line.py +++ b/plotly/graph_objs/scatter3d/_line.py @@ -36,8 +36,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -58,8 +58,8 @@ def cauto(self): `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -305,8 +305,8 @@ def reversescale(self): will correspond to the last color in the array and `line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -325,8 +325,8 @@ def showscale(self): trace. Has an effect only if in `line.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/_marker.py b/plotly/graph_objs/scatter3d/_marker.py index 7f4e4222586..2f9344723ef 100644 --- a/plotly/graph_objs/scatter3d/_marker.py +++ b/plotly/graph_objs/scatter3d/_marker.py @@ -43,8 +43,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -66,8 +66,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -182,9 +182,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -334,8 +334,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -354,8 +354,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/line/_colorbar.py b/plotly/graph_objs/scatter3d/line/_colorbar.py index 3410e79e492..d1407503689 100644 --- a/plotly/graph_objs/scatter3d/line/_colorbar.py +++ b/plotly/graph_objs/scatter3d/line/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py b/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py index 66e80c356fd..877c27e426c 100644 --- a/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/marker/_colorbar.py b/plotly/graph_objs/scatter3d/marker/_colorbar.py index bf4dc51d999..640e5ffc931 100644 --- a/plotly/graph_objs/scatter3d/marker/_colorbar.py +++ b/plotly/graph_objs/scatter3d/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/marker/_line.py b/plotly/graph_objs/scatter3d/marker/_line.py index 50011a6ad16..34860068f64 100644 --- a/plotly/graph_objs/scatter3d/marker/_line.py +++ b/plotly/graph_objs/scatter3d/marker/_line.py @@ -33,8 +33,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -56,8 +56,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -173,9 +173,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -267,8 +267,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py index 5c95cfa9e46..1db91397e7b 100644 --- a/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/projection/_x.py b/plotly/graph_objs/scatter3d/projection/_x.py index 20945837a5c..06ecd63aca9 100644 --- a/plotly/graph_objs/scatter3d/projection/_x.py +++ b/plotly/graph_objs/scatter3d/projection/_x.py @@ -52,8 +52,8 @@ def show(self): """ Sets whether or not projections are shown along the x axis. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/projection/_y.py b/plotly/graph_objs/scatter3d/projection/_y.py index fb4d7df7659..e0e9685ac1d 100644 --- a/plotly/graph_objs/scatter3d/projection/_y.py +++ b/plotly/graph_objs/scatter3d/projection/_y.py @@ -52,8 +52,8 @@ def show(self): """ Sets whether or not projections are shown along the y axis. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatter3d/projection/_z.py b/plotly/graph_objs/scatter3d/projection/_z.py index 16655eb0e62..d60bc55242f 100644 --- a/plotly/graph_objs/scatter3d/projection/_z.py +++ b/plotly/graph_objs/scatter3d/projection/_z.py @@ -52,8 +52,8 @@ def show(self): """ Sets whether or not projections are shown along the z axis. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattercarpet/_hoverlabel.py b/plotly/graph_objs/scattercarpet/_hoverlabel.py index 682c7b6d5a5..dfb16b81521 100644 --- a/plotly/graph_objs/scattercarpet/_hoverlabel.py +++ b/plotly/graph_objs/scattercarpet/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattercarpet/_marker.py b/plotly/graph_objs/scattercarpet/_marker.py index 3dfb1f719c4..dfb9a3afab3 100644 --- a/plotly/graph_objs/scattercarpet/_marker.py +++ b/plotly/graph_objs/scattercarpet/_marker.py @@ -110,8 +110,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -133,8 +133,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -249,9 +249,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -454,8 +454,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -474,8 +474,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattercarpet/marker/_colorbar.py b/plotly/graph_objs/scattercarpet/marker/_colorbar.py index 4e48955f2e9..dfbfe570bb1 100644 --- a/plotly/graph_objs/scattercarpet/marker/_colorbar.py +++ b/plotly/graph_objs/scattercarpet/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattercarpet/marker/_line.py b/plotly/graph_objs/scattercarpet/marker/_line.py index bc682af241d..ace49436632 100644 --- a/plotly/graph_objs/scattercarpet/marker/_line.py +++ b/plotly/graph_objs/scattercarpet/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py index 6edaabebc3a..26f41374dd7 100644 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergeo/_hoverlabel.py b/plotly/graph_objs/scattergeo/_hoverlabel.py index ad20c75481b..55ee903b004 100644 --- a/plotly/graph_objs/scattergeo/_hoverlabel.py +++ b/plotly/graph_objs/scattergeo/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergeo/_marker.py b/plotly/graph_objs/scattergeo/_marker.py index 3db78be645d..0ea1ab62272 100644 --- a/plotly/graph_objs/scattergeo/_marker.py +++ b/plotly/graph_objs/scattergeo/_marker.py @@ -111,8 +111,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -134,8 +134,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -250,9 +250,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -436,8 +436,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -456,8 +456,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergeo/marker/_colorbar.py b/plotly/graph_objs/scattergeo/marker/_colorbar.py index 1b0b000f8f9..e5da382e134 100644 --- a/plotly/graph_objs/scattergeo/marker/_colorbar.py +++ b/plotly/graph_objs/scattergeo/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergeo/marker/_line.py b/plotly/graph_objs/scattergeo/marker/_line.py index c721fcd3fda..eb84d8966fe 100644 --- a/plotly/graph_objs/scattergeo/marker/_line.py +++ b/plotly/graph_objs/scattergeo/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py index af8aad9f59c..538e61b7d62 100644 --- a/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergl/_error_x.py b/plotly/graph_objs/scattergl/_error_x.py index b2efa2a8eac..2cb27d7b8a5 100644 --- a/plotly/graph_objs/scattergl/_error_x.py +++ b/plotly/graph_objs/scattergl/_error_x.py @@ -127,8 +127,8 @@ def color(self, val): @property def copy_ystyle(self): """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) + The 'copy_ystyle' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -283,8 +283,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergl/_error_y.py b/plotly/graph_objs/scattergl/_error_y.py index 376febb9945..b750644bb53 100644 --- a/plotly/graph_objs/scattergl/_error_y.py +++ b/plotly/graph_objs/scattergl/_error_y.py @@ -130,8 +130,8 @@ def symmetric(self): in both direction (top/bottom for vertical bars, left/right for horizontal bars. - The 'symmetric' property must be specified as a bool - (either True, or False) + The 'symmetric' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -266,8 +266,8 @@ def visible(self): """ Determines whether or not this set of error bars is visible. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergl/_hoverlabel.py b/plotly/graph_objs/scattergl/_hoverlabel.py index 188bcaa10f5..95fcf655f2d 100644 --- a/plotly/graph_objs/scattergl/_hoverlabel.py +++ b/plotly/graph_objs/scattergl/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergl/_marker.py b/plotly/graph_objs/scattergl/_marker.py index c26e398252b..89d2af3b0ab 100644 --- a/plotly/graph_objs/scattergl/_marker.py +++ b/plotly/graph_objs/scattergl/_marker.py @@ -84,8 +84,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -107,8 +107,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -223,9 +223,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -390,8 +390,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -410,8 +410,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergl/marker/_colorbar.py b/plotly/graph_objs/scattergl/marker/_colorbar.py index ef8bf9dcee4..553b18a49dd 100644 --- a/plotly/graph_objs/scattergl/marker/_colorbar.py +++ b/plotly/graph_objs/scattergl/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergl/marker/_line.py b/plotly/graph_objs/scattergl/marker/_line.py index 70e996045d0..e841871b7b8 100644 --- a/plotly/graph_objs/scattergl/marker/_line.py +++ b/plotly/graph_objs/scattergl/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py index c621d4a7304..01beca9416b 100644 --- a/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermap/_cluster.py b/plotly/graph_objs/scattermap/_cluster.py index 06e8863f976..bd66fd02c53 100644 --- a/plotly/graph_objs/scattermap/_cluster.py +++ b/plotly/graph_objs/scattermap/_cluster.py @@ -67,8 +67,8 @@ def enabled(self): """ Determines whether clustering is enabled or disabled. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermap/_hoverlabel.py b/plotly/graph_objs/scattermap/_hoverlabel.py index bc8014a4239..66cbe4592fb 100644 --- a/plotly/graph_objs/scattermap/_hoverlabel.py +++ b/plotly/graph_objs/scattermap/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermap/_marker.py b/plotly/graph_objs/scattermap/_marker.py index 94795ed505b..98d0d00d04b 100644 --- a/plotly/graph_objs/scattermap/_marker.py +++ b/plotly/graph_objs/scattermap/_marker.py @@ -40,8 +40,8 @@ def allowoverlap(self): """ Flag to draw all symbols, even if they overlap. - The 'allowoverlap' property must be specified as a bool - (either True, or False) + The 'allowoverlap' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -104,8 +104,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -127,8 +127,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -243,9 +243,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -391,8 +391,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -411,8 +411,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermap/marker/_colorbar.py b/plotly/graph_objs/scattermap/marker/_colorbar.py index 645e4cf7abc..1e5d8893a0c 100644 --- a/plotly/graph_objs/scattermap/marker/_colorbar.py +++ b/plotly/graph_objs/scattermap/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py index 9185e884e2f..5be9a746d59 100644 --- a/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermapbox/_cluster.py b/plotly/graph_objs/scattermapbox/_cluster.py index c064caf25aa..da20f28f59e 100644 --- a/plotly/graph_objs/scattermapbox/_cluster.py +++ b/plotly/graph_objs/scattermapbox/_cluster.py @@ -67,8 +67,8 @@ def enabled(self): """ Determines whether clustering is enabled or disabled. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermapbox/_hoverlabel.py b/plotly/graph_objs/scattermapbox/_hoverlabel.py index 338e80e4f9b..c7dee08e2a0 100644 --- a/plotly/graph_objs/scattermapbox/_hoverlabel.py +++ b/plotly/graph_objs/scattermapbox/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermapbox/_marker.py b/plotly/graph_objs/scattermapbox/_marker.py index 00c348d965c..8238d0b4bb3 100644 --- a/plotly/graph_objs/scattermapbox/_marker.py +++ b/plotly/graph_objs/scattermapbox/_marker.py @@ -40,8 +40,8 @@ def allowoverlap(self): """ Flag to draw all symbols, even if they overlap. - The 'allowoverlap' property must be specified as a bool - (either True, or False) + The 'allowoverlap' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -104,8 +104,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -127,8 +127,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -243,9 +243,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -391,8 +391,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -411,8 +411,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermapbox/marker/_colorbar.py b/plotly/graph_objs/scattermapbox/marker/_colorbar.py index 1553adb8abe..2fd4120791a 100644 --- a/plotly/graph_objs/scattermapbox/marker/_colorbar.py +++ b/plotly/graph_objs/scattermapbox/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py index e41d613d46b..389874e110b 100644 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolar/_hoverlabel.py b/plotly/graph_objs/scatterpolar/_hoverlabel.py index 35582b36126..7e2153e988d 100644 --- a/plotly/graph_objs/scatterpolar/_hoverlabel.py +++ b/plotly/graph_objs/scatterpolar/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolar/_marker.py b/plotly/graph_objs/scatterpolar/_marker.py index 377e839e56e..d8b1256c0b6 100644 --- a/plotly/graph_objs/scatterpolar/_marker.py +++ b/plotly/graph_objs/scatterpolar/_marker.py @@ -110,8 +110,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -133,8 +133,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -249,9 +249,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -454,8 +454,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -474,8 +474,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolar/marker/_colorbar.py b/plotly/graph_objs/scatterpolar/marker/_colorbar.py index 7d8a9906913..c030d486faa 100644 --- a/plotly/graph_objs/scatterpolar/marker/_colorbar.py +++ b/plotly/graph_objs/scatterpolar/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolar/marker/_line.py b/plotly/graph_objs/scatterpolar/marker/_line.py index a3a941e33cd..62c236545cc 100644 --- a/plotly/graph_objs/scatterpolar/marker/_line.py +++ b/plotly/graph_objs/scatterpolar/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py index 730bf5362c0..0e9cbe71200 100644 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolargl/_hoverlabel.py b/plotly/graph_objs/scatterpolargl/_hoverlabel.py index 90d4b704a6b..991fb4cc259 100644 --- a/plotly/graph_objs/scatterpolargl/_hoverlabel.py +++ b/plotly/graph_objs/scatterpolargl/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolargl/_marker.py b/plotly/graph_objs/scatterpolargl/_marker.py index 616c489bb1b..58de2f153f8 100644 --- a/plotly/graph_objs/scatterpolargl/_marker.py +++ b/plotly/graph_objs/scatterpolargl/_marker.py @@ -84,8 +84,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -107,8 +107,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -223,9 +223,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -390,8 +390,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -410,8 +410,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolargl/marker/_colorbar.py b/plotly/graph_objs/scatterpolargl/marker/_colorbar.py index a2077a1ee64..402023d3d17 100644 --- a/plotly/graph_objs/scatterpolargl/marker/_colorbar.py +++ b/plotly/graph_objs/scatterpolargl/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolargl/marker/_line.py b/plotly/graph_objs/scatterpolargl/marker/_line.py index 9f480f97951..c0c4da09fa8 100644 --- a/plotly/graph_objs/scatterpolargl/marker/_line.py +++ b/plotly/graph_objs/scatterpolargl/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py index d30c15b4cc6..6256b8459d5 100644 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattersmith/_hoverlabel.py b/plotly/graph_objs/scattersmith/_hoverlabel.py index 0ab9d03d405..a24e3c637a5 100644 --- a/plotly/graph_objs/scattersmith/_hoverlabel.py +++ b/plotly/graph_objs/scattersmith/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattersmith/_marker.py b/plotly/graph_objs/scattersmith/_marker.py index 4b5dfcfc1e1..d9da69cac13 100644 --- a/plotly/graph_objs/scattersmith/_marker.py +++ b/plotly/graph_objs/scattersmith/_marker.py @@ -110,8 +110,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -133,8 +133,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -249,9 +249,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -454,8 +454,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -474,8 +474,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattersmith/marker/_colorbar.py b/plotly/graph_objs/scattersmith/marker/_colorbar.py index 9d657acdee9..38711e90780 100644 --- a/plotly/graph_objs/scattersmith/marker/_colorbar.py +++ b/plotly/graph_objs/scattersmith/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattersmith/marker/_line.py b/plotly/graph_objs/scattersmith/marker/_line.py index e12c8fc079b..686a967711b 100644 --- a/plotly/graph_objs/scattersmith/marker/_line.py +++ b/plotly/graph_objs/scattersmith/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py index 6fcd9e5b2b4..02d48a3f3a9 100644 --- a/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterternary/_hoverlabel.py b/plotly/graph_objs/scatterternary/_hoverlabel.py index 1cc94d43474..8af023fd886 100644 --- a/plotly/graph_objs/scatterternary/_hoverlabel.py +++ b/plotly/graph_objs/scatterternary/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterternary/_marker.py b/plotly/graph_objs/scatterternary/_marker.py index defc23e95a4..e6f4844c4f7 100644 --- a/plotly/graph_objs/scatterternary/_marker.py +++ b/plotly/graph_objs/scatterternary/_marker.py @@ -110,8 +110,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -133,8 +133,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -249,9 +249,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -454,8 +454,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -474,8 +474,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterternary/marker/_colorbar.py b/plotly/graph_objs/scatterternary/marker/_colorbar.py index 0f771078768..90a07f4b493 100644 --- a/plotly/graph_objs/scatterternary/marker/_colorbar.py +++ b/plotly/graph_objs/scatterternary/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterternary/marker/_line.py b/plotly/graph_objs/scatterternary/marker/_line.py index df4544e66ad..f8bd6147b99 100644 --- a/plotly/graph_objs/scatterternary/marker/_line.py +++ b/plotly/graph_objs/scatterternary/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py index 266d0af18b7..8d5d9b5c7bc 100644 --- a/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/_diagonal.py b/plotly/graph_objs/splom/_diagonal.py index a29d8e7a219..49a9cf75097 100644 --- a/plotly/graph_objs/splom/_diagonal.py +++ b/plotly/graph_objs/splom/_diagonal.py @@ -16,8 +16,8 @@ def visible(self): Determines whether or not subplots on the diagonal are displayed. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/_dimension.py b/plotly/graph_objs/splom/_dimension.py index beb275e9ecf..14f8d5e28b1 100644 --- a/plotly/graph_objs/splom/_dimension.py +++ b/plotly/graph_objs/splom/_dimension.py @@ -150,8 +150,8 @@ def visible(self): Note that even visible false dimension contribute to the default grid generate by this splom trace. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/_hoverlabel.py b/plotly/graph_objs/splom/_hoverlabel.py index 2ac795e5564..36b2c5eeb4a 100644 --- a/plotly/graph_objs/splom/_hoverlabel.py +++ b/plotly/graph_objs/splom/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/_marker.py b/plotly/graph_objs/splom/_marker.py index 548795887c0..f42ce026a62 100644 --- a/plotly/graph_objs/splom/_marker.py +++ b/plotly/graph_objs/splom/_marker.py @@ -84,8 +84,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -107,8 +107,8 @@ def cauto(self): to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -223,9 +223,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -390,8 +390,8 @@ def reversescale(self): `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -410,8 +410,8 @@ def showscale(self): trace. Has an effect only if in `marker.color` is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/dimension/_axis.py b/plotly/graph_objs/splom/dimension/_axis.py index 0366dfc8ba4..06e4c07dbc0 100644 --- a/plotly/graph_objs/splom/dimension/_axis.py +++ b/plotly/graph_objs/splom/dimension/_axis.py @@ -17,8 +17,8 @@ def matches(self): dimension match. Equivalent to setting the `matches` axis attribute in the layout with the correct axis id. - The 'matches' property must be specified as a bool - (either True, or False) + The 'matches' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/marker/_colorbar.py b/plotly/graph_objs/splom/marker/_colorbar.py index 43a60b76e68..8ac128aec69 100644 --- a/plotly/graph_objs/splom/marker/_colorbar.py +++ b/plotly/graph_objs/splom/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/marker/_line.py b/plotly/graph_objs/splom/marker/_line.py index 764a9528007..2c52ce95355 100644 --- a/plotly/graph_objs/splom/marker/_line.py +++ b/plotly/graph_objs/splom/marker/_line.py @@ -34,8 +34,8 @@ def autocolorscale(self): default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -57,8 +57,8 @@ def cauto(self): array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -174,9 +174,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -268,8 +268,8 @@ def reversescale(self): array and `marker.line.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py index 10c4054596b..5c6c4020fa2 100644 --- a/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/streamtube/_colorbar.py b/plotly/graph_objs/streamtube/_colorbar.py index 9b6d5eb5326..50ec9e8ea39 100644 --- a/plotly/graph_objs/streamtube/_colorbar.py +++ b/plotly/graph_objs/streamtube/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/streamtube/_hoverlabel.py b/plotly/graph_objs/streamtube/_hoverlabel.py index 5cd6eb37be7..cadef33fa6c 100644 --- a/plotly/graph_objs/streamtube/_hoverlabel.py +++ b/plotly/graph_objs/streamtube/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py b/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py index 3bb5efa7a24..8748a3b445c 100644 --- a/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/sunburst/_hoverlabel.py b/plotly/graph_objs/sunburst/_hoverlabel.py index b0a24bdf92d..5286153f634 100644 --- a/plotly/graph_objs/sunburst/_hoverlabel.py +++ b/plotly/graph_objs/sunburst/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/sunburst/_marker.py b/plotly/graph_objs/sunburst/_marker.py index 4a4234e4fe6..df5e4c80b47 100644 --- a/plotly/graph_objs/sunburst/_marker.py +++ b/plotly/graph_objs/sunburst/_marker.py @@ -36,8 +36,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -58,8 +58,8 @@ def cauto(self): set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -144,9 +144,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -314,8 +314,8 @@ def reversescale(self): correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -334,8 +334,8 @@ def showscale(self): trace. Has an effect only if colors is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/sunburst/marker/_colorbar.py b/plotly/graph_objs/sunburst/marker/_colorbar.py index 4ec1c710613..d09ff1552b0 100644 --- a/plotly/graph_objs/sunburst/marker/_colorbar.py +++ b/plotly/graph_objs/sunburst/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py index 893cef9cc2f..90635297945 100644 --- a/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/_colorbar.py b/plotly/graph_objs/surface/_colorbar.py index 566b7c347a8..1473bf94dbf 100644 --- a/plotly/graph_objs/surface/_colorbar.py +++ b/plotly/graph_objs/surface/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/_hoverlabel.py b/plotly/graph_objs/surface/_hoverlabel.py index a16aad9bc07..5411df78a85 100644 --- a/plotly/graph_objs/surface/_hoverlabel.py +++ b/plotly/graph_objs/surface/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/colorbar/_tickformatstop.py b/plotly/graph_objs/surface/colorbar/_tickformatstop.py index 893ffaf4de5..839cce1eac0 100644 --- a/plotly/graph_objs/surface/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/surface/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/contours/_x.py b/plotly/graph_objs/surface/contours/_x.py index 9df51307d8a..3964452b6ed 100644 --- a/plotly/graph_objs/surface/contours/_x.py +++ b/plotly/graph_objs/surface/contours/_x.py @@ -69,8 +69,8 @@ def highlight(self): Determines whether or not contour lines about the x dimension are highlighted on hover. - The 'highlight' property must be specified as a bool - (either True, or False) + The 'highlight' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def show(self): Determines whether or not contour lines about the x dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -203,8 +203,8 @@ def usecolormap(self): An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale". - The 'usecolormap' property must be specified as a bool - (either True, or False) + The 'usecolormap' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/contours/_y.py b/plotly/graph_objs/surface/contours/_y.py index 00c104246f2..3f4cf8126e4 100644 --- a/plotly/graph_objs/surface/contours/_y.py +++ b/plotly/graph_objs/surface/contours/_y.py @@ -69,8 +69,8 @@ def highlight(self): Determines whether or not contour lines about the y dimension are highlighted on hover. - The 'highlight' property must be specified as a bool - (either True, or False) + The 'highlight' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def show(self): Determines whether or not contour lines about the y dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -203,8 +203,8 @@ def usecolormap(self): An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale". - The 'usecolormap' property must be specified as a bool - (either True, or False) + The 'usecolormap' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/contours/_z.py b/plotly/graph_objs/surface/contours/_z.py index 62d241683ed..9069c084027 100644 --- a/plotly/graph_objs/surface/contours/_z.py +++ b/plotly/graph_objs/surface/contours/_z.py @@ -69,8 +69,8 @@ def highlight(self): Determines whether or not contour lines about the z dimension are highlighted on hover. - The 'highlight' property must be specified as a bool - (either True, or False) + The 'highlight' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,8 +147,8 @@ def show(self): Determines whether or not contour lines about the z dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -203,8 +203,8 @@ def usecolormap(self): An alternate to "color". Determines whether or not the contour lines are colored using the trace "colorscale". - The 'usecolormap' property must be specified as a bool - (either True, or False) + The 'usecolormap' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/contours/x/_project.py b/plotly/graph_objs/surface/contours/x/_project.py index d2ac9d60eea..25b7d844f24 100644 --- a/plotly/graph_objs/surface/contours/x/_project.py +++ b/plotly/graph_objs/surface/contours/x/_project.py @@ -18,8 +18,8 @@ def x(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'x' property must be specified as a bool - (either True, or False) + The 'x' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -39,8 +39,8 @@ def y(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'y' property must be specified as a bool - (either True, or False) + The 'y' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -60,8 +60,8 @@ def z(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'z' property must be specified as a bool - (either True, or False) + The 'z' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/contours/y/_project.py b/plotly/graph_objs/surface/contours/y/_project.py index 9a026aa204d..41f407dcf6e 100644 --- a/plotly/graph_objs/surface/contours/y/_project.py +++ b/plotly/graph_objs/surface/contours/y/_project.py @@ -18,8 +18,8 @@ def x(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'x' property must be specified as a bool - (either True, or False) + The 'x' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -39,8 +39,8 @@ def y(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'y' property must be specified as a bool - (either True, or False) + The 'y' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -60,8 +60,8 @@ def z(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'z' property must be specified as a bool - (either True, or False) + The 'z' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/surface/contours/z/_project.py b/plotly/graph_objs/surface/contours/z/_project.py index 51ae7efa751..d0710dacf53 100644 --- a/plotly/graph_objs/surface/contours/z/_project.py +++ b/plotly/graph_objs/surface/contours/z/_project.py @@ -18,8 +18,8 @@ def x(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'x' property must be specified as a bool - (either True, or False) + The 'x' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -39,8 +39,8 @@ def y(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'y' property must be specified as a bool - (either True, or False) + The 'y' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -60,8 +60,8 @@ def z(self): projected lines are shown on hover. If `show` is set to True, the projected lines are shown in permanence. - The 'z' property must be specified as a bool - (either True, or False) + The 'z' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/table/_hoverlabel.py b/plotly/graph_objs/table/_hoverlabel.py index 9dbe00feb46..c4ab5a1c506 100644 --- a/plotly/graph_objs/table/_hoverlabel.py +++ b/plotly/graph_objs/table/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/treemap/_hoverlabel.py b/plotly/graph_objs/treemap/_hoverlabel.py index 0add4c9b62c..c79ecd3c173 100644 --- a/plotly/graph_objs/treemap/_hoverlabel.py +++ b/plotly/graph_objs/treemap/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/treemap/_marker.py b/plotly/graph_objs/treemap/_marker.py index 2d2af08ac58..7fb375d147c 100644 --- a/plotly/graph_objs/treemap/_marker.py +++ b/plotly/graph_objs/treemap/_marker.py @@ -39,8 +39,8 @@ def autocolorscale(self): according to whether numbers in the `color` array are all positive, all negative or mixed. - The 'autocolorscale' property must be specified as a bool - (either True, or False) + The 'autocolorscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -61,8 +61,8 @@ def cauto(self): set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user. - The 'cauto' property must be specified as a bool - (either True, or False) + The 'cauto' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -147,9 +147,9 @@ def coloraxis(self): axis. The 'coloraxis' property is an identifier of a particular - subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' - optionally followed by an integer >= 1 - (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + subplot, of type 'coloraxis', that may be specified as: + - the string 'coloraxis' optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) Returns ------- @@ -380,8 +380,8 @@ def reversescale(self): correspond to the last color in the array and `marker.cmax` will correspond to the first color. - The 'reversescale' property must be specified as a bool - (either True, or False) + The 'reversescale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -400,8 +400,8 @@ def showscale(self): trace. Has an effect only if colors is set to a numerical array. - The 'showscale' property must be specified as a bool - (either True, or False) + The 'showscale' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/treemap/_pathbar.py b/plotly/graph_objs/treemap/_pathbar.py index 295cc48086c..3243811b535 100644 --- a/plotly/graph_objs/treemap/_pathbar.py +++ b/plotly/graph_objs/treemap/_pathbar.py @@ -97,8 +97,8 @@ def visible(self): Determines if the path bar is drawn i.e. outside the trace `domain` and with one pixel gap. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/treemap/marker/_colorbar.py b/plotly/graph_objs/treemap/marker/_colorbar.py index 66b4a2d75fe..c156fb8119e 100644 --- a/plotly/graph_objs/treemap/marker/_colorbar.py +++ b/plotly/graph_objs/treemap/marker/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py index 08aeb3e6d4a..7c657e037d8 100644 --- a/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/violin/_box.py b/plotly/graph_objs/violin/_box.py index 7aa241eff79..ebb18b16f15 100644 --- a/plotly/graph_objs/violin/_box.py +++ b/plotly/graph_objs/violin/_box.py @@ -57,8 +57,8 @@ def visible(self): Determines if an miniature box plot is drawn inside the violins. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/violin/_hoverlabel.py b/plotly/graph_objs/violin/_hoverlabel.py index 63140fdd703..b52dde907cf 100644 --- a/plotly/graph_objs/violin/_hoverlabel.py +++ b/plotly/graph_objs/violin/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/violin/_meanline.py b/plotly/graph_objs/violin/_meanline.py index 4eecef24909..75a34cd5793 100644 --- a/plotly/graph_objs/violin/_meanline.py +++ b/plotly/graph_objs/violin/_meanline.py @@ -40,8 +40,8 @@ def visible(self): mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/_colorbar.py b/plotly/graph_objs/volume/_colorbar.py index 7a8f61833da..ab97f844882 100644 --- a/plotly/graph_objs/volume/_colorbar.py +++ b/plotly/graph_objs/volume/_colorbar.py @@ -357,8 +357,8 @@ def separatethousands(self): """ If "true", even 4-digit integers are separated - The 'separatethousands' property must be specified as a bool - (either True, or False) + The 'separatethousands' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- @@ -397,8 +397,8 @@ def showticklabels(self): """ Determines whether or not the tick labels are drawn. - The 'showticklabels' property must be specified as a bool - (either True, or False) + The 'showticklabels' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/_contour.py b/plotly/graph_objs/volume/_contour.py index 61a81b52bb7..eb18bfd4821 100644 --- a/plotly/graph_objs/volume/_contour.py +++ b/plotly/graph_objs/volume/_contour.py @@ -37,8 +37,8 @@ def show(self): """ Sets whether or not dynamic contours are shown on hover - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/_hoverlabel.py b/plotly/graph_objs/volume/_hoverlabel.py index 04637a665db..880b0c9c25a 100644 --- a/plotly/graph_objs/volume/_hoverlabel.py +++ b/plotly/graph_objs/volume/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/_spaceframe.py b/plotly/graph_objs/volume/_spaceframe.py index ff07188f9e2..ce6aa7fbbd4 100644 --- a/plotly/graph_objs/volume/_spaceframe.py +++ b/plotly/graph_objs/volume/_spaceframe.py @@ -38,8 +38,8 @@ def show(self): iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/_surface.py b/plotly/graph_objs/volume/_surface.py index 0f35f1beb62..7aa95512e6f 100644 --- a/plotly/graph_objs/volume/_surface.py +++ b/plotly/graph_objs/volume/_surface.py @@ -84,8 +84,8 @@ def show(self): """ Hides/displays surfaces between minimum and maximum iso-values. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/caps/_x.py b/plotly/graph_objs/volume/caps/_x.py index 2c3c692eb78..d67636b2e98 100644 --- a/plotly/graph_objs/volume/caps/_x.py +++ b/plotly/graph_objs/volume/caps/_x.py @@ -39,8 +39,8 @@ def show(self): the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/caps/_y.py b/plotly/graph_objs/volume/caps/_y.py index 6ad9bdeb0a7..8248f0dd208 100644 --- a/plotly/graph_objs/volume/caps/_y.py +++ b/plotly/graph_objs/volume/caps/_y.py @@ -39,8 +39,8 @@ def show(self): the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/caps/_z.py b/plotly/graph_objs/volume/caps/_z.py index 37064fd7a44..212ec6c5bbb 100644 --- a/plotly/graph_objs/volume/caps/_z.py +++ b/plotly/graph_objs/volume/caps/_z.py @@ -39,8 +39,8 @@ def show(self): the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/colorbar/_tickformatstop.py b/plotly/graph_objs/volume/colorbar/_tickformatstop.py index 67ddb279d77..653eb3b1ce6 100644 --- a/plotly/graph_objs/volume/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/volume/colorbar/_tickformatstop.py @@ -39,8 +39,8 @@ def enabled(self): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. - The 'enabled' property must be specified as a bool - (either True, or False) + The 'enabled' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/slices/_x.py b/plotly/graph_objs/volume/slices/_x.py index b77e2c4af5f..d3d69c095d0 100644 --- a/plotly/graph_objs/volume/slices/_x.py +++ b/plotly/graph_objs/volume/slices/_x.py @@ -76,8 +76,8 @@ def show(self): Determines whether or not slice planes about the x dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/slices/_y.py b/plotly/graph_objs/volume/slices/_y.py index feb362278d8..02268eb86c4 100644 --- a/plotly/graph_objs/volume/slices/_y.py +++ b/plotly/graph_objs/volume/slices/_y.py @@ -76,8 +76,8 @@ def show(self): Determines whether or not slice planes about the y dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/volume/slices/_z.py b/plotly/graph_objs/volume/slices/_z.py index 4b37d9d764c..871a163b8f8 100644 --- a/plotly/graph_objs/volume/slices/_z.py +++ b/plotly/graph_objs/volume/slices/_z.py @@ -76,8 +76,8 @@ def show(self): Determines whether or not slice planes about the z dimension are drawn. - The 'show' property must be specified as a bool - (either True, or False) + The 'show' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/waterfall/_connector.py b/plotly/graph_objs/waterfall/_connector.py index e76bd9d4ed6..413dfb738e4 100644 --- a/plotly/graph_objs/waterfall/_connector.py +++ b/plotly/graph_objs/waterfall/_connector.py @@ -53,8 +53,8 @@ def visible(self): """ Determines if connector lines are drawn. - The 'visible' property must be specified as a bool - (either True, or False) + The 'visible' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/plotly/graph_objs/waterfall/_hoverlabel.py b/plotly/graph_objs/waterfall/_hoverlabel.py index 39d6e7b0ce9..784e0db27d6 100644 --- a/plotly/graph_objs/waterfall/_hoverlabel.py +++ b/plotly/graph_objs/waterfall/_hoverlabel.py @@ -215,8 +215,8 @@ def showarrow(self): Sets whether or not to show the hover label arrow/triangle pointing to the data point. - The 'showarrow' property must be specified as a bool - (either True, or False) + The 'showarrow' property is a boolean and must be specified as: + - A boolean value: True or False Returns ------- diff --git a/pyproject.toml b/pyproject.toml index 2b42e32ff3b..9757a6a987b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,7 +32,7 @@ classifiers = [ ] requires-python = ">=3.8" license = {file="LICENSE.txt"} -version = "6.5.1" +version = "6.5.2" dependencies = [ "narwhals>=1.15.1", "packaging" diff --git a/tests/test_plotly_utils/validators/test_boolean_validator.py b/tests/test_plotly_utils/validators/test_boolean_validator.py index f4f80335a85..3a5fef42233 100644 --- a/tests/test_plotly_utils/validators/test_boolean_validator.py +++ b/tests/test_plotly_utils/validators/test_boolean_validator.py @@ -12,6 +12,14 @@ def validator(request): return BooleanValidator("prop", "parent", dflt=request.param) +@pytest.fixture(params=[True, False]) +def validator_aok(request): + return BooleanValidator("prop", "parent", dflt=request.param, array_ok=True) + + +# Array not ok (default) + + # Acceptance @pytest.mark.parametrize("val", [True, False]) def test_acceptance(val, validator): @@ -25,3 +33,24 @@ def test_rejection(val, validator): validator.validate_coerce(val) assert "Invalid value" in str(validation_failure.value) + + +# Array ok + + +# Acceptance +@pytest.mark.parametrize("val", [(True, False), [True, False]]) +def test_acceptance_aok(val, validator_aok): + v = validator_aok.validate_coerce(val) + assert list(val) == v + + +# Rejection +@pytest.mark.parametrize( + "val", [(True, "Planet Express"), ["Hubert Farnsworth", False]] +) +def test_rejection_aok(val, validator_aok): + with pytest.raises(ValueError) as validation_failure: + validator_aok.validate_coerce(val) + + assert "Invalid elements" in str(validation_failure.value) diff --git a/tests/test_plotly_utils/validators/test_subplotid_validator.py b/tests/test_plotly_utils/validators/test_subplotid_validator.py index 85ff0573e08..09e57c0ee99 100644 --- a/tests/test_plotly_utils/validators/test_subplotid_validator.py +++ b/tests/test_plotly_utils/validators/test_subplotid_validator.py @@ -11,15 +11,29 @@ def validator(): return SubplotidValidator("prop", "parent", dflt="geo") +@pytest.fixture() +def validator_aok(): + return SubplotidValidator("prop", "parent", dflt="legend", array_ok=True) + + # Tests +# Array not ok (default) # Acceptance + + @pytest.mark.parametrize("val", ["geo"] + ["geo%d" % i for i in range(2, 10)]) def test_acceptance(val, validator): assert validator.validate_coerce(val) == val +# Coercion from {base}1 to {base} +def test_coerce(validator): + v = validator.validate_coerce("geo1") + assert ("geo") == v + + # Rejection by type @pytest.mark.parametrize("val", [23, [], {}, set(), np_inf(), np_nan()]) def test_rejection_type(val, validator): @@ -43,3 +57,55 @@ def test_rejection_value(val, validator): validator.validate_coerce(val) assert "Invalid value" in str(validation_failure.value) + + +# Array ok + +# Acceptance + + +@pytest.mark.parametrize( + "val", + ["legend2", ["legend", "legend2"], ["legend", "legend2"]], +) +def test_acceptance_aok(val, validator_aok): + v = validator_aok.validate_coerce(val) + if isinstance(val, tuple): + assert val == tuple(v) + else: + assert val == v + + +# Coercion from {base}1 to {base} +def test_coerce_aok(validator_aok): + v = validator_aok.validate_coerce(("legend1", "legend2")) + assert ("legend", "legend2") == tuple(v) + + +# Rejection by type +@pytest.mark.parametrize("val", [23, [2, 3], {}, set(), np_inf(), np_nan()]) +def test_rejection_type_aok(val, validator_aok): + with pytest.raises(ValueError) as validation_failure: + validator_aok.validate_coerce(val) + + failure_msg = str(validation_failure.value) + assert "Invalid value" in failure_msg or "Invalid elements" in failure_msg + + +# Rejection by value +@pytest.mark.parametrize( + "val", + [ + "", # Cannot be empty + "bogus", # Must begin with 'geo' + "legend0", # If followed by a number the number must be > 1, + ["", "legend"], + ("bogus", "legend2"), + ], +) +def test_rejection_value_aok(val, validator_aok): + with pytest.raises(ValueError) as validation_failure: + validator_aok.validate_coerce(val) + + failure_msg = str(validation_failure.value) + assert "Invalid value" in failure_msg or "Invalid elements" in failure_msg diff --git a/uv.lock b/uv.lock index 12780b5e394..22aac76b084 100644 --- a/uv.lock +++ b/uv.lock @@ -4277,7 +4277,7 @@ wheels = [ [[package]] name = "plotly" -version = "6.5.1" +version = "6.5.2" source = { editable = "." } dependencies = [ { name = "narwhals" },