From e6ac58f6b5b24c2d880d59c5907b11c370f10af4 Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Wed, 17 Oct 2018 19:13:18 -0400 Subject: [PATCH 1/5] Updated InfoArrayValidator description to take into account 2-dimensional arrays --- _plotly_utils/basevalidators.py | 92 ++++++++++++++++--- codegen/utils.py | 5 +- plotly/graph_objs/_choropleth.py | 2 +- plotly/graph_objs/_cone.py | 2 +- plotly/graph_objs/_contour.py | 2 +- plotly/graph_objs/_contourcarpet.py | 2 +- plotly/graph_objs/_figure.py | 6 +- plotly/graph_objs/_figurewidget.py | 6 +- plotly/graph_objs/_heatmap.py | 2 +- plotly/graph_objs/_heatmapgl.py | 2 +- plotly/graph_objs/_histogram.py | 8 +- plotly/graph_objs/_histogram2d.py | 8 +- plotly/graph_objs/_histogram2dcontour.py | 8 +- plotly/graph_objs/_layout.py | 18 ++-- plotly/graph_objs/_mesh3d.py | 2 +- plotly/graph_objs/_splom.py | 14 ++- plotly/graph_objs/_streamtube.py | 2 +- plotly/graph_objs/_surface.py | 2 +- plotly/graph_objs/_violin.py | 4 +- plotly/graph_objs/bar/_marker.py | 2 +- plotly/graph_objs/bar/marker/_colorbar.py | 6 +- .../bar/marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/barpolar/_marker.py | 2 +- .../graph_objs/barpolar/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/carpet/_aaxis.py | 4 +- plotly/graph_objs/carpet/_baxis.py | 4 +- .../carpet/aaxis/_tickformatstop.py | 4 +- .../carpet/baxis/_tickformatstop.py | 4 +- plotly/graph_objs/choropleth/_colorbar.py | 6 +- .../choropleth/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/cone/_colorbar.py | 6 +- .../cone/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/contour/_colorbar.py | 6 +- .../contour/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/contourcarpet/_colorbar.py | 6 +- .../contourcarpet/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/heatmap/_colorbar.py | 6 +- .../heatmap/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/heatmapgl/_colorbar.py | 6 +- .../heatmapgl/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/histogram/_cumulative.py | 6 +- plotly/graph_objs/histogram/_marker.py | 2 +- .../graph_objs/histogram/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/histogram2d/_colorbar.py | 6 +- .../histogram2d/colorbar/_tickformatstop.py | 4 +- .../histogram2dcontour/_colorbar.py | 6 +- .../colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/layout/_angularaxis.py | 8 +- plotly/graph_objs/layout/_grid.py | 67 +++++++------- plotly/graph_objs/layout/_polar.py | 8 +- plotly/graph_objs/layout/_radialaxis.py | 8 +- plotly/graph_objs/layout/_scene.py | 6 +- plotly/graph_objs/layout/_ternary.py | 6 +- plotly/graph_objs/layout/_xaxis.py | 14 +-- plotly/graph_objs/layout/_yaxis.py | 14 +-- plotly/graph_objs/layout/geo/_domain.py | 8 +- plotly/graph_objs/layout/geo/_lataxis.py | 4 +- plotly/graph_objs/layout/geo/_lonaxis.py | 4 +- plotly/graph_objs/layout/geo/_projection.py | 4 +- plotly/graph_objs/layout/grid/_domain.py | 8 +- plotly/graph_objs/layout/mapbox/_domain.py | 8 +- .../graph_objs/layout/polar/_angularaxis.py | 6 +- plotly/graph_objs/layout/polar/_domain.py | 8 +- plotly/graph_objs/layout/polar/_radialaxis.py | 10 +- .../polar/angularaxis/_tickformatstop.py | 4 +- .../polar/radialaxis/_tickformatstop.py | 4 +- plotly/graph_objs/layout/scene/_domain.py | 8 +- plotly/graph_objs/layout/scene/_xaxis.py | 10 +- plotly/graph_objs/layout/scene/_yaxis.py | 10 +- plotly/graph_objs/layout/scene/_zaxis.py | 10 +- .../layout/scene/xaxis/_tickformatstop.py | 4 +- .../layout/scene/yaxis/_tickformatstop.py | 4 +- .../layout/scene/zaxis/_tickformatstop.py | 4 +- plotly/graph_objs/layout/slider/_step.py | 4 +- plotly/graph_objs/layout/ternary/_aaxis.py | 6 +- plotly/graph_objs/layout/ternary/_baxis.py | 6 +- plotly/graph_objs/layout/ternary/_caxis.py | 6 +- plotly/graph_objs/layout/ternary/_domain.py | 8 +- .../layout/ternary/aaxis/_tickformatstop.py | 4 +- .../layout/ternary/baxis/_tickformatstop.py | 4 +- .../layout/ternary/caxis/_tickformatstop.py | 4 +- .../graph_objs/layout/updatemenu/_button.py | 4 +- .../graph_objs/layout/xaxis/_rangeslider.py | 4 +- .../layout/xaxis/_tickformatstop.py | 4 +- .../layout/xaxis/rangeslider/_yaxis.py | 4 +- .../layout/yaxis/_tickformatstop.py | 4 +- plotly/graph_objs/mesh3d/_colorbar.py | 6 +- .../mesh3d/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/parcoords/_dimension.py | 14 ++- plotly/graph_objs/parcoords/_domain.py | 8 +- plotly/graph_objs/parcoords/_line.py | 2 +- plotly/graph_objs/parcoords/line/_colorbar.py | 6 +- .../line/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/pie/_domain.py | 8 +- plotly/graph_objs/sankey/_domain.py | 8 +- plotly/graph_objs/scatter/_marker.py | 2 +- plotly/graph_objs/scatter/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scatter3d/_marker.py | 2 +- .../graph_objs/scatter3d/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scattercarpet/_marker.py | 2 +- .../scattercarpet/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scattergeo/_marker.py | 2 +- .../graph_objs/scattergeo/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scattergl/_marker.py | 2 +- .../graph_objs/scattergl/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scattermapbox/_marker.py | 2 +- .../scattermapbox/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scatterpolar/_marker.py | 2 +- .../scatterpolar/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scatterpolargl/_marker.py | 2 +- .../scatterpolargl/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/scatterternary/_marker.py | 2 +- .../scatterternary/marker/_colorbar.py | 6 +- .../marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/splom/_marker.py | 2 +- plotly/graph_objs/splom/marker/_colorbar.py | 6 +- .../splom/marker/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/streamtube/_colorbar.py | 6 +- .../streamtube/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/surface/_colorbar.py | 6 +- .../surface/colorbar/_tickformatstop.py | 4 +- plotly/graph_objs/table/_domain.py | 8 +- plotly/validators/_histogram.py | 2 +- plotly/validators/_histogram2d.py | 2 +- plotly/validators/_histogram2dcontour.py | 2 +- plotly/validators/bar/marker/_colorbar.py | 2 +- .../validators/barpolar/marker/_colorbar.py | 2 +- plotly/validators/choropleth/_colorbar.py | 2 +- plotly/validators/cone/_colorbar.py | 2 +- plotly/validators/contour/_colorbar.py | 2 +- plotly/validators/contourcarpet/_colorbar.py | 2 +- plotly/validators/heatmap/_colorbar.py | 2 +- plotly/validators/heatmapgl/_colorbar.py | 2 +- plotly/validators/histogram/_cumulative.py | 2 +- .../validators/histogram/marker/_colorbar.py | 2 +- plotly/validators/histogram2d/_colorbar.py | 2 +- .../histogram2dcontour/_colorbar.py | 2 +- plotly/validators/layout/_grid.py | 14 +-- plotly/validators/layout/_xaxis.py | 2 +- plotly/validators/layout/_yaxis.py | 2 +- .../validators/layout/polar/_angularaxis.py | 2 +- plotly/validators/layout/polar/_radialaxis.py | 2 +- plotly/validators/layout/scene/_xaxis.py | 2 +- plotly/validators/layout/scene/_yaxis.py | 2 +- plotly/validators/layout/scene/_zaxis.py | 2 +- plotly/validators/layout/ternary/_aaxis.py | 2 +- plotly/validators/layout/ternary/_baxis.py | 2 +- plotly/validators/layout/ternary/_caxis.py | 2 +- plotly/validators/mesh3d/_colorbar.py | 2 +- plotly/validators/parcoords/line/_colorbar.py | 2 +- plotly/validators/scatter/marker/_colorbar.py | 2 +- .../validators/scatter3d/marker/_colorbar.py | 2 +- .../scattercarpet/marker/_colorbar.py | 2 +- .../validators/scattergeo/marker/_colorbar.py | 2 +- .../validators/scattergl/marker/_colorbar.py | 2 +- .../scattermapbox/marker/_colorbar.py | 2 +- .../scatterpolar/marker/_colorbar.py | 2 +- .../scatterpolargl/marker/_colorbar.py | 2 +- .../scatterternary/marker/_colorbar.py | 2 +- plotly/validators/splom/marker/_colorbar.py | 2 +- plotly/validators/streamtube/_colorbar.py | 2 +- plotly/validators/surface/_colorbar.py | 2 +- 172 files changed, 504 insertions(+), 432 deletions(-) diff --git a/_plotly_utils/basevalidators.py b/_plotly_utils/basevalidators.py index b79627936d7..d3f1bec9b3d 100644 --- a/_plotly_utils/basevalidators.py +++ b/_plotly_utils/basevalidators.py @@ -1608,7 +1608,8 @@ class InfoArrayValidator(BaseValidator): ], "otherOpts": [ "dflt", - "freeLength" + "freeLength", + "dimensions" ] } """ @@ -1618,10 +1619,14 @@ def __init__(self, parent_name, items, free_length=None, + dimensions=None, **kwargs): super(InfoArrayValidator, self).__init__( plotly_name=plotly_name, parent_name=parent_name, **kwargs) + self.items = items + self.dimensions = dimensions if dimensions else 1 + self.free_length = free_length # Instantiate validators for each info array element self.item_validators = [] @@ -1634,21 +1639,86 @@ def __init__(self, item, element_name, parent_name) self.item_validators.append(item_validator) - self.free_length = free_length - def description(self): - upto = ' up to' if self.free_length else '' + + # Cases + # 1) self.items is array, self.dimensions is 1 + # a) free_length=True + # b) free_length=False + # 2) self.items is array, self.dimensions is 2 + # (requires free_length=True) + # 3) self.items is scalar (requires free_length=True) + # a) dimensions=1 + # b) dimensions=2 + # + # dimensions can be set to '1-2' to indicate the both are accepted + # desc = """\ - The '{plotly_name}' property is an info array that may be specified as a - list or tuple of{upto} {N} elements where: -""".format(plotly_name=self.plotly_name, - upto=upto, + The '{plotly_name}' property is an info array that may be specified as:\ +""".format(plotly_name=self.plotly_name) + + if isinstance(self.items, list): + # ### Case 1 ### + if self.dimensions in (1, '1-2'): + upto = (' up to' + if self.free_length and self.dimensions == 1 + else '') + desc += """ + + * a list or tuple of{upto} {N} elements where:\ +""".format(upto=upto, N=len(self.item_validators)) - for i, item_validator in enumerate(self.item_validators): - el_desc = item_validator.description().strip() - desc = desc + """ + for i, item_validator in enumerate(self.item_validators): + el_desc = item_validator.description().strip() + desc = desc + """ +({i}) {el_desc}""".format(i=i, el_desc=el_desc) + + # ### Case 2 ### + if self.dimensions in ('1-2', 2): + assert self.free_length + + desc += """ + + * a 2D list where:""" + for i, item_validator in enumerate(self.item_validators): + # Update name for 2d + orig_name = item_validator.plotly_name + item_validator.plotly_name = "{name}[i][{i}]".format( + name=self.plotly_name, i=i) + + el_desc = item_validator.description().strip() + desc = desc + """ ({i}) {el_desc}""".format(i=i, el_desc=el_desc) + item_validator.plotly_name = orig_name + else: + # ### Case 3 ### + assert self.free_length + item_validator = self.item_validators[0] + orig_name = item_validator.plotly_name + + if self.dimensions in (1, '1-2'): + item_validator.plotly_name = "{name}[i]".format( + name=self.plotly_name) + + el_desc = item_validator.description().strip() + + desc += """ + * a list of elements where: + {el_desc} +""".format(el_desc=el_desc) + + if self.dimensions in ('1-2', 2): + item_validator.plotly_name = "{name}[i][j]".format( + name=self.plotly_name) + + el_desc = item_validator.description().strip() + desc += """ + * a 2D list where: + {el_desc} +""".format(el_desc=el_desc) + + item_validator.plotly_name = orig_name return desc diff --git a/codegen/utils.py b/codegen/utils.py index a2fa7f701cb..1fb7c6bb07d 100644 --- a/codegen/utils.py +++ b/codegen/utils.py @@ -146,9 +146,10 @@ def format_description(desc): desc = re.sub('(^|[\s(,.:])\*(\S+)\*([\s),.:]|$)', r'\1"\2"\3', desc) # Special case strings that don't satisfy regex above - other_strings = ['Courier New', 'Droid Sans', 'Droid Serif', + other_strings = ['', 'Courier New', 'Droid Sans', 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', - 'Open Sans', 'PT Sans Narrow', 'Times New Roman'] + 'Open Sans', 'PT Sans Narrow', 'Times New Roman', + 'bottom plot', 'top plot'] for s in other_strings: desc = desc.replace("*%s*" % s, '"%s"' % s) diff --git a/plotly/graph_objs/_choropleth.py b/plotly/graph_objs/_choropleth.py index f4281efe77d..f30ad58e6de 100644 --- a/plotly/graph_objs/_choropleth.py +++ b/plotly/graph_objs/_choropleth.py @@ -187,7 +187,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_cone.py b/plotly/graph_objs/_cone.py index 3edbba4ff4b..6553904c2a0 100644 --- a/plotly/graph_objs/_cone.py +++ b/plotly/graph_objs/_cone.py @@ -276,7 +276,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_contour.py b/plotly/graph_objs/_contour.py index d646e7f8e38..5f3c042957f 100644 --- a/plotly/graph_objs/_contour.py +++ b/plotly/graph_objs/_contour.py @@ -209,7 +209,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_contourcarpet.py b/plotly/graph_objs/_contourcarpet.py index 5437f79269e..7a0f295c475 100644 --- a/plotly/graph_objs/_contourcarpet.py +++ b/plotly/graph_objs/_contourcarpet.py @@ -402,7 +402,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_figure.py b/plotly/graph_objs/_figure.py index 6d3873d7546..297d396e0df 100644 --- a/plotly/graph_objs/_figure.py +++ b/plotly/graph_objs/_figure.py @@ -3530,7 +3530,7 @@ def add_histogram( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar @@ -3822,7 +3822,7 @@ def add_histogram2d( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar @@ -4144,7 +4144,7 @@ def add_histogram2dcontour( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar diff --git a/plotly/graph_objs/_figurewidget.py b/plotly/graph_objs/_figurewidget.py index 09b21f6dbe0..ca818b4d7dd 100644 --- a/plotly/graph_objs/_figurewidget.py +++ b/plotly/graph_objs/_figurewidget.py @@ -3530,7 +3530,7 @@ def add_histogram( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar @@ -3822,7 +3822,7 @@ def add_histogram2d( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar @@ -4144,7 +4144,7 @@ def add_histogram2dcontour( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar diff --git a/plotly/graph_objs/_heatmap.py b/plotly/graph_objs/_heatmap.py index 201f4b60dc1..6d22ab79143 100644 --- a/plotly/graph_objs/_heatmap.py +++ b/plotly/graph_objs/_heatmap.py @@ -186,7 +186,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_heatmapgl.py b/plotly/graph_objs/_heatmapgl.py index ebecf75bdb3..cbb0f7fc80b 100644 --- a/plotly/graph_objs/_heatmapgl.py +++ b/plotly/graph_objs/_heatmapgl.py @@ -187,7 +187,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_histogram.py b/plotly/graph_objs/_histogram.py index 5a857bc7e66..4f6855130d1 100644 --- a/plotly/graph_objs/_histogram.py +++ b/plotly/graph_objs/_histogram.py @@ -84,7 +84,7 @@ def cumulative(self): and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the same - as their equivalents without "density": ** and + as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and *probability density* both rise to the number of sample @@ -335,7 +335,7 @@ def histfunc(self, val): def histnorm(self): """ Specifies the type of normalization used for this histogram - trace. If **, the span of each bar corresponds to the number of + trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with @@ -1255,7 +1255,7 @@ def _prop_descriptions(self): respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar @@ -1473,7 +1473,7 @@ def __init__( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar diff --git a/plotly/graph_objs/_histogram2d.py b/plotly/graph_objs/_histogram2d.py index cea5756c4f3..c5fafb1a504 100644 --- a/plotly/graph_objs/_histogram2d.py +++ b/plotly/graph_objs/_histogram2d.py @@ -233,7 +233,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -406,7 +406,7 @@ def histfunc(self, val): def histnorm(self): """ Specifies the type of normalization used for this histogram - trace. If **, the span of each bar corresponds to the number of + trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with @@ -1370,7 +1370,7 @@ def _prop_descriptions(self): respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar @@ -1623,7 +1623,7 @@ def __init__( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar diff --git a/plotly/graph_objs/_histogram2dcontour.py b/plotly/graph_objs/_histogram2dcontour.py index 65e61c1258c..a83cb69db77 100644 --- a/plotly/graph_objs/_histogram2dcontour.py +++ b/plotly/graph_objs/_histogram2dcontour.py @@ -256,7 +256,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -515,7 +515,7 @@ def histfunc(self, val): def histnorm(self): """ Specifies the type of normalization used for this histogram - trace. If **, the span of each bar corresponds to the number of + trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / fraction of occurrences with @@ -1488,7 +1488,7 @@ def _prop_descriptions(self): respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar @@ -1753,7 +1753,7 @@ def __init__( respectively. histnorm Specifies the type of normalization used for this - histogram trace. If **, the span of each bar + histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar diff --git a/plotly/graph_objs/_layout.py b/plotly/graph_objs/_layout.py index fab9890737d..4765a3f0574 100644 --- a/plotly/graph_objs/_layout.py +++ b/plotly/graph_objs/_layout.py @@ -907,7 +907,7 @@ def grid(self): Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like - "xy" or "x3y2", or ** to leave that cell empty. + "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can @@ -917,8 +917,8 @@ def grid(self): Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or - ** to not put an x axis in that column. Entries - other than ** must be unique. Ignored if + "" to not put an x axis in that column. Entries + other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs. xgap @@ -929,15 +929,15 @@ def grid(self): xside Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. - *bottom plot* is the lowest plot that each x - axis is used in. "top" and *top plot* are + "bottom plot" is the lowest plot that each x + axis is used in. "top" and "top plot" are similar. yaxes Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or - ** to not put a y axis in that row. Entries - other than ** must be unique. Ignored if + "" to not put a y axis in that row. Entries + other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs. ygap @@ -2795,7 +2795,7 @@ def xaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -3177,7 +3177,7 @@ def yaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_mesh3d.py b/plotly/graph_objs/_mesh3d.py index 941f69ba1a4..e6a5fecd11a 100644 --- a/plotly/graph_objs/_mesh3d.py +++ b/plotly/graph_objs/_mesh3d.py @@ -349,7 +349,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_splom.py b/plotly/graph_objs/_splom.py index 4bc4962893c..e93ead8e772 100644 --- a/plotly/graph_objs/_splom.py +++ b/plotly/graph_objs/_splom.py @@ -737,10 +737,9 @@ def xaxes(self): default, a splom will match the first N xaxes where N is the number of input dimensions. - The 'xaxes' property is an info array that may be specified as a - list or tuple of up to 1 elements where: - - (0) The 'xaxes[0]' property is an identifier of a particular + 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.) @@ -764,10 +763,9 @@ def yaxes(self): default, a splom will match the first N yaxes where N is the number of input dimensions. - The 'yaxes' property is an info array that may be specified as a - list or tuple of up to 1 elements where: - - (0) The 'yaxes[0]' property is an identifier of a particular + 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.) diff --git a/plotly/graph_objs/_streamtube.py b/plotly/graph_objs/_streamtube.py index b43a7ecbe10..ef6eed8b6ae 100644 --- a/plotly/graph_objs/_streamtube.py +++ b/plotly/graph_objs/_streamtube.py @@ -254,7 +254,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_surface.py b/plotly/graph_objs/_surface.py index 482c47f88f4..dd3dc3059ec 100644 --- a/plotly/graph_objs/_surface.py +++ b/plotly/graph_objs/_surface.py @@ -253,7 +253,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/_violin.py b/plotly/graph_objs/_violin.py index 1f8149d82d6..a6320bedbbd 100644 --- a/plotly/graph_objs/_violin.py +++ b/plotly/graph_objs/_violin.py @@ -753,9 +753,9 @@ def span(self): be computed. Has an effect only when `spanmode` is set to "manual". - The 'span' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'span' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'span[0]' property accepts values of any type (1) The 'span[1]' property accepts values of any type diff --git a/plotly/graph_objs/bar/_marker.py b/plotly/graph_objs/bar/_marker.py index fedec467678..2757e9c6f81 100644 --- a/plotly/graph_objs/bar/_marker.py +++ b/plotly/graph_objs/bar/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/bar/marker/_colorbar.py b/plotly/graph_objs/bar/marker/_colorbar.py index 39f6c4b519e..374cfe0b0f0 100644 --- a/plotly/graph_objs/bar/marker/_colorbar.py +++ b/plotly/graph_objs/bar/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py index 24ab58e4556..2ec155427ef 100644 --- a/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/barpolar/_marker.py b/plotly/graph_objs/barpolar/_marker.py index 68415ad529c..a58a129e216 100644 --- a/plotly/graph_objs/barpolar/_marker.py +++ b/plotly/graph_objs/barpolar/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/barpolar/marker/_colorbar.py b/plotly/graph_objs/barpolar/marker/_colorbar.py index a1a57b225b0..40b1557f063 100644 --- a/plotly/graph_objs/barpolar/marker/_colorbar.py +++ b/plotly/graph_objs/barpolar/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py index d0716ed9c44..e2d98b3e771 100644 --- a/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/carpet/_aaxis.py b/plotly/graph_objs/carpet/_aaxis.py index 89de875f4a3..d72212b8b67 100644 --- a/plotly/graph_objs/carpet/_aaxis.py +++ b/plotly/graph_objs/carpet/_aaxis.py @@ -749,9 +749,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type diff --git a/plotly/graph_objs/carpet/_baxis.py b/plotly/graph_objs/carpet/_baxis.py index a83242836b5..ff9e8666fca 100644 --- a/plotly/graph_objs/carpet/_baxis.py +++ b/plotly/graph_objs/carpet/_baxis.py @@ -749,9 +749,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type diff --git a/plotly/graph_objs/carpet/aaxis/_tickformatstop.py b/plotly/graph_objs/carpet/aaxis/_tickformatstop.py index 43db5837f37..8155edc2153 100644 --- a/plotly/graph_objs/carpet/aaxis/_tickformatstop.py +++ b/plotly/graph_objs/carpet/aaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/carpet/baxis/_tickformatstop.py b/plotly/graph_objs/carpet/baxis/_tickformatstop.py index e370918ae68..bcb6ee66055 100644 --- a/plotly/graph_objs/carpet/baxis/_tickformatstop.py +++ b/plotly/graph_objs/carpet/baxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/choropleth/_colorbar.py b/plotly/graph_objs/choropleth/_colorbar.py index 52b00b87af7..4b5c8cc938f 100644 --- a/plotly/graph_objs/choropleth/_colorbar.py +++ b/plotly/graph_objs/choropleth/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py b/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py index bde28758a9e..34c84613422 100644 --- a/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/cone/_colorbar.py b/plotly/graph_objs/cone/_colorbar.py index acdc7f9215d..f747943b022 100644 --- a/plotly/graph_objs/cone/_colorbar.py +++ b/plotly/graph_objs/cone/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/cone/colorbar/_tickformatstop.py b/plotly/graph_objs/cone/colorbar/_tickformatstop.py index 6b33a6a8e77..024ed03207a 100644 --- a/plotly/graph_objs/cone/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/cone/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/contour/_colorbar.py b/plotly/graph_objs/contour/_colorbar.py index 43e5dfc5ed0..3c188b79e85 100644 --- a/plotly/graph_objs/contour/_colorbar.py +++ b/plotly/graph_objs/contour/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/contour/colorbar/_tickformatstop.py b/plotly/graph_objs/contour/colorbar/_tickformatstop.py index 061c51a1a3f..7db8664dced 100644 --- a/plotly/graph_objs/contour/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/contour/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/contourcarpet/_colorbar.py b/plotly/graph_objs/contourcarpet/_colorbar.py index 578cad099da..57ecfcc714d 100644 --- a/plotly/graph_objs/contourcarpet/_colorbar.py +++ b/plotly/graph_objs/contourcarpet/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py b/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py index a1c983a8a3d..d9c8d0e6d84 100644 --- a/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/heatmap/_colorbar.py b/plotly/graph_objs/heatmap/_colorbar.py index 5f779b66346..dc815a52e58 100644 --- a/plotly/graph_objs/heatmap/_colorbar.py +++ b/plotly/graph_objs/heatmap/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py b/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py index 92d05e3aa8a..e1ac0c0364f 100644 --- a/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/heatmapgl/_colorbar.py b/plotly/graph_objs/heatmapgl/_colorbar.py index 5fdeb1954e6..8128c4f5e83 100644 --- a/plotly/graph_objs/heatmapgl/_colorbar.py +++ b/plotly/graph_objs/heatmapgl/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py b/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py index 6d295eea29f..73869b95002 100644 --- a/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/histogram/_cumulative.py b/plotly/graph_objs/histogram/_cumulative.py index a4a9ac03601..fa2b0a83a71 100644 --- a/plotly/graph_objs/histogram/_cumulative.py +++ b/plotly/graph_objs/histogram/_cumulative.py @@ -63,7 +63,7 @@ def enabled(self): binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the same as their - equivalents without "density": ** and "density" both rise to + equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and *probability density* both rise to the number of sample points. @@ -109,7 +109,7 @@ def _prop_descriptions(self): the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the - same as their equivalents without "density": ** and + same as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and *probability density* both rise to the number of sample points. @@ -149,7 +149,7 @@ def __init__( the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the - same as their equivalents without "density": ** and + same as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and *probability density* both rise to the number of sample points. diff --git a/plotly/graph_objs/histogram/_marker.py b/plotly/graph_objs/histogram/_marker.py index 41ed3b27c29..ec2ce83fa34 100644 --- a/plotly/graph_objs/histogram/_marker.py +++ b/plotly/graph_objs/histogram/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/histogram/marker/_colorbar.py b/plotly/graph_objs/histogram/marker/_colorbar.py index c4dd458ec20..ffb3e772735 100644 --- a/plotly/graph_objs/histogram/marker/_colorbar.py +++ b/plotly/graph_objs/histogram/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py index effe5a512ce..fabf3fde128 100644 --- a/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/histogram2d/_colorbar.py b/plotly/graph_objs/histogram2d/_colorbar.py index 7867b6ced30..e07abe6708c 100644 --- a/plotly/graph_objs/histogram2d/_colorbar.py +++ b/plotly/graph_objs/histogram2d/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py index 941e09fad78..431f2ed61e0 100644 --- a/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/histogram2dcontour/_colorbar.py b/plotly/graph_objs/histogram2dcontour/_colorbar.py index 7f4ce7b2ae2..23042070666 100644 --- a/plotly/graph_objs/histogram2dcontour/_colorbar.py +++ b/plotly/graph_objs/histogram2dcontour/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py index e94a166cae3..e22a3c1b14d 100644 --- a/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/_angularaxis.py b/plotly/graph_objs/layout/_angularaxis.py index 313596436d2..c3476752ef9 100644 --- a/plotly/graph_objs/layout/_angularaxis.py +++ b/plotly/graph_objs/layout/_angularaxis.py @@ -12,9 +12,9 @@ def domain(self): Polar chart subplots are not supported yet. This key has currently no effect. - The 'domain' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'domain' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'domain[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'domain[1]' property is a number and may be specified as: @@ -59,9 +59,9 @@ def range(self): Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this angular axis. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property is a number and may be specified as: - An int or float (1) The 'range[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/_grid.py b/plotly/graph_objs/layout/_grid.py index d04db0ebc5e..a61b972d1f5 100644 --- a/plotly/graph_objs/layout/_grid.py +++ b/plotly/graph_objs/layout/_grid.py @@ -143,16 +143,15 @@ def subplots(self): """ Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian - subplot id, like "xy" or "x3y2", or ** to leave that cell + subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute. - The 'subplots' property is an info array that may be specified as a - list or tuple of up to 1 elements where: - - (0) The 'subplots[0]' property is an enumeration that may be specified as: + The 'subplots' property is an info array that may be specified as: + * a 2D list where: + The 'subplots[i][j]' property is an enumeration that may be specified as: - One of the following enumeration values: [''] - A string that matches one of the following regular expressions: @@ -175,15 +174,14 @@ def xaxes(self): """ Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", - "x2", etc., or ** to not put an x axis in that column. Entries - other than ** must be unique. Ignored if `subplots` is present. + "x2", etc., or "" to not put an x axis in that column. Entries + other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs. - The 'xaxes' property is an info array that may be specified as a - list or tuple of up to 1 elements where: - - (0) The 'xaxes[0]' property is an enumeration that may be specified as: + The 'xaxes' property is an info array that may be specified as: + * a list of elements where: + The 'xaxes[i]' property is an enumeration that may be specified as: - One of the following enumeration values: [''] - A string that matches one of the following regular expressions: @@ -227,8 +225,8 @@ def xgap(self, val): def xside(self): """ Sets where the x axis labels and titles go. "bottom" means the - very bottom of the grid. *bottom plot* is the lowest plot that - each x axis is used in. "top" and *top plot* are similar. + very bottom of the grid. "bottom plot" is the lowest plot that + each x axis is used in. "top" and "top plot" are similar. The 'xside' property is an enumeration that may be specified as: - One of the following enumeration values: @@ -251,15 +249,14 @@ def yaxes(self): """ Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", - "y2", etc., or ** to not put a y axis in that row. Entries - other than ** must be unique. Ignored if `subplots` is present. + "y2", etc., or "" to not put a y axis in that row. Entries + other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs. - The 'yaxes' property is an info array that may be specified as a - list or tuple of up to 1 elements where: - - (0) The 'yaxes[0]' property is an enumeration that may be specified as: + The 'yaxes' property is an info array that may be specified as: + * a list of elements where: + The 'yaxes[i]' property is an enumeration that may be specified as: - One of the following enumeration values: [''] - A string that matches one of the following regular expressions: @@ -362,7 +359,7 @@ def _prop_descriptions(self): subplots Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should - be a cartesian subplot id, like "xy" or "x3y2", or ** + be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non- cartesian subplots and traces that support `domain` can @@ -371,8 +368,8 @@ def _prop_descriptions(self): xaxes Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis - id like "x", "x2", etc., or ** to not put an x axis in - that column. Entries other than ** must be unique. + id like "x", "x2", etc., or "" to not put an x axis in + that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs. xgap @@ -382,14 +379,14 @@ def _prop_descriptions(self): independent grids. xside Sets where the x axis labels and titles go. "bottom" - means the very bottom of the grid. *bottom plot* is the - lowest plot that each x axis is used in. "top" and *top - plot* are similar. + means the very bottom of the grid. "bottom plot" is the + lowest plot that each x axis is used in. "top" and "top + plot" are similar. yaxes Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis - id like "y", "y2", etc., or ** to not put a y axis in - that row. Entries other than ** must be unique. Ignored + id like "y", "y2", etc., or "" to not put a y axis in + that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs. ygap @@ -459,7 +456,7 @@ def __init__( subplots Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should - be a cartesian subplot id, like "xy" or "x3y2", or ** + be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non- cartesian subplots and traces that support `domain` can @@ -468,8 +465,8 @@ def __init__( xaxes Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis - id like "x", "x2", etc., or ** to not put an x axis in - that column. Entries other than ** must be unique. + id like "x", "x2", etc., or "" to not put an x axis in + that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs. xgap @@ -479,14 +476,14 @@ def __init__( independent grids. xside Sets where the x axis labels and titles go. "bottom" - means the very bottom of the grid. *bottom plot* is the - lowest plot that each x axis is used in. "top" and *top - plot* are similar. + means the very bottom of the grid. "bottom plot" is the + lowest plot that each x axis is used in. "top" and "top + plot" are similar. yaxes Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis - id like "y", "y2", etc., or ** to not put a y axis in - that row. Entries other than ** must be unique. Ignored + id like "y", "y2", etc., or "" to not put a y axis in + that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs. ygap diff --git a/plotly/graph_objs/layout/_polar.py b/plotly/graph_objs/layout/_polar.py index c52ec4e2cb9..f6a5fcc4796 100644 --- a/plotly/graph_objs/layout/_polar.py +++ b/plotly/graph_objs/layout/_polar.py @@ -215,7 +215,7 @@ def angularaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -681,7 +681,7 @@ def radialaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -738,9 +738,9 @@ def sector(self): counterclockwise direction with 0 corresponding to rightmost limit of the polar subplot. - The 'sector' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'sector' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'sector[0]' property is a number and may be specified as: - An int or float (1) The 'sector[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/_radialaxis.py b/plotly/graph_objs/layout/_radialaxis.py index deb08fbb7e1..3fadece8ae3 100644 --- a/plotly/graph_objs/layout/_radialaxis.py +++ b/plotly/graph_objs/layout/_radialaxis.py @@ -12,9 +12,9 @@ def domain(self): Polar chart subplots are not supported yet. This key has currently no effect. - The 'domain' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'domain' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'domain[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'domain[1]' property is a number and may be specified as: @@ -81,9 +81,9 @@ def range(self): Legacy polar charts are deprecated! Please switch to "polar" subplots. Defines the start and end point of this radial axis. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property is a number and may be specified as: - An int or float (1) The 'range[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/_scene.py b/plotly/graph_objs/layout/_scene.py index 0c8131baa09..21b4c300d1f 100644 --- a/plotly/graph_objs/layout/_scene.py +++ b/plotly/graph_objs/layout/_scene.py @@ -680,7 +680,7 @@ def xaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -975,7 +975,7 @@ def yaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1270,7 +1270,7 @@ def zaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/_ternary.py b/plotly/graph_objs/layout/_ternary.py index 76e7f4e9312..3b026b964a6 100644 --- a/plotly/graph_objs/layout/_ternary.py +++ b/plotly/graph_objs/layout/_ternary.py @@ -179,7 +179,7 @@ def aaxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -391,7 +391,7 @@ def baxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -662,7 +662,7 @@ def caxis(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/_xaxis.py b/plotly/graph_objs/layout/_xaxis.py index 87ba1b0cec6..f910d060d81 100644 --- a/plotly/graph_objs/layout/_xaxis.py +++ b/plotly/graph_objs/layout/_xaxis.py @@ -293,9 +293,9 @@ def domain(self): """ Sets the domain of this axis (in plot fraction). - The 'domain' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'domain' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'domain[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'domain[1]' property is a number and may be specified as: @@ -719,9 +719,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type @@ -1601,7 +1601,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -2251,7 +2251,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -2657,7 +2657,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/_yaxis.py b/plotly/graph_objs/layout/_yaxis.py index 6dba7d7dc39..51982c585c9 100644 --- a/plotly/graph_objs/layout/_yaxis.py +++ b/plotly/graph_objs/layout/_yaxis.py @@ -293,9 +293,9 @@ def domain(self): """ Sets the domain of this axis (in plot fraction). - The 'domain' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'domain' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'domain[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'domain[1]' property is a number and may be specified as: @@ -719,9 +719,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type @@ -1480,7 +1480,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -2124,7 +2124,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -2522,7 +2522,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/geo/_domain.py b/plotly/graph_objs/layout/geo/_domain.py index 4b609638da9..ff5bc9e6177 100644 --- a/plotly/graph_objs/layout/geo/_domain.py +++ b/plotly/graph_objs/layout/geo/_domain.py @@ -64,9 +64,9 @@ def x(self): general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both. - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -92,9 +92,9 @@ def y(self): general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both. - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/geo/_lataxis.py b/plotly/graph_objs/layout/geo/_lataxis.py index d6aab95dad4..ba7fb16562d 100644 --- a/plotly/graph_objs/layout/geo/_lataxis.py +++ b/plotly/graph_objs/layout/geo/_lataxis.py @@ -111,9 +111,9 @@ def range(self): Sets the range of this axis (in degrees), sets the map's clipped coordinates. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property is a number and may be specified as: - An int or float (1) The 'range[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/geo/_lonaxis.py b/plotly/graph_objs/layout/geo/_lonaxis.py index a49fde4ddde..2d07ad45af5 100644 --- a/plotly/graph_objs/layout/geo/_lonaxis.py +++ b/plotly/graph_objs/layout/geo/_lonaxis.py @@ -111,9 +111,9 @@ def range(self): Sets the range of this axis (in degrees), sets the map's clipped coordinates. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property is a number and may be specified as: - An int or float (1) The 'range[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/geo/_projection.py b/plotly/graph_objs/layout/geo/_projection.py index fcc6b93f632..237faf49cb5 100644 --- a/plotly/graph_objs/layout/geo/_projection.py +++ b/plotly/graph_objs/layout/geo/_projection.py @@ -12,9 +12,9 @@ def parallels(self): For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere. - The 'parallels' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'parallels' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'parallels[0]' property is a number and may be specified as: - An int or float (1) The 'parallels[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/grid/_domain.py b/plotly/graph_objs/layout/grid/_domain.py index 50ba3e20150..aa2e7b4a7fc 100644 --- a/plotly/graph_objs/layout/grid/_domain.py +++ b/plotly/graph_objs/layout/grid/_domain.py @@ -13,9 +13,9 @@ def x(self): fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -40,9 +40,9 @@ def y(self): fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/mapbox/_domain.py b/plotly/graph_objs/layout/mapbox/_domain.py index 7aa62bce3ff..a26f9e6a424 100644 --- a/plotly/graph_objs/layout/mapbox/_domain.py +++ b/plotly/graph_objs/layout/mapbox/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this mapbox subplot (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -82,9 +82,9 @@ def y(self): Sets the vertical domain of this mapbox subplot (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/polar/_angularaxis.py b/plotly/graph_objs/layout/polar/_angularaxis.py index eb7d650f52d..3c787fcab32 100644 --- a/plotly/graph_objs/layout/polar/_angularaxis.py +++ b/plotly/graph_objs/layout/polar/_angularaxis.py @@ -995,7 +995,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1367,7 +1367,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1626,7 +1626,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/polar/_domain.py b/plotly/graph_objs/layout/polar/_domain.py index f8d0dec50d4..078efa681e4 100644 --- a/plotly/graph_objs/layout/polar/_domain.py +++ b/plotly/graph_objs/layout/polar/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this polar subplot (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -82,9 +82,9 @@ def y(self): Sets the vertical domain of this polar subplot (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/polar/_radialaxis.py b/plotly/graph_objs/layout/polar/_radialaxis.py index 059eaa64149..e4e4634450f 100644 --- a/plotly/graph_objs/layout/polar/_radialaxis.py +++ b/plotly/graph_objs/layout/polar/_radialaxis.py @@ -530,9 +530,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type @@ -1057,7 +1057,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1514,7 +1514,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1800,7 +1800,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py b/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py index 54317713096..a39b86cd4e8 100644 --- a/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py b/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py index 5d6815c3c63..45d43106b9b 100644 --- a/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/scene/_domain.py b/plotly/graph_objs/layout/scene/_domain.py index a71449ba699..37276ef8e25 100644 --- a/plotly/graph_objs/layout/scene/_domain.py +++ b/plotly/graph_objs/layout/scene/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this scene subplot (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -82,9 +82,9 @@ def y(self): Sets the vertical domain of this scene subplot (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/scene/_xaxis.py b/plotly/graph_objs/layout/scene/_xaxis.py index a6b7400491f..786c76735ed 100644 --- a/plotly/graph_objs/layout/scene/_xaxis.py +++ b/plotly/graph_objs/layout/scene/_xaxis.py @@ -563,9 +563,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type @@ -1229,7 +1229,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1796,7 +1796,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -2106,7 +2106,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/scene/_yaxis.py b/plotly/graph_objs/layout/scene/_yaxis.py index dc07c68415b..30b0313ef3f 100644 --- a/plotly/graph_objs/layout/scene/_yaxis.py +++ b/plotly/graph_objs/layout/scene/_yaxis.py @@ -563,9 +563,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type @@ -1229,7 +1229,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1796,7 +1796,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -2106,7 +2106,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/scene/_zaxis.py b/plotly/graph_objs/layout/scene/_zaxis.py index c9c66be26ff..ba81e986d70 100644 --- a/plotly/graph_objs/layout/scene/_zaxis.py +++ b/plotly/graph_objs/layout/scene/_zaxis.py @@ -563,9 +563,9 @@ def range(self): should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type @@ -1229,7 +1229,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1796,7 +1796,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -2106,7 +2106,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py index 069bf6af284..e92735e3405 100644 --- a/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py index 72c8332685b..eed2a871347 100644 --- a/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py index 7b6806d3314..a64ce2f9a51 100644 --- a/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/slider/_step.py b/plotly/graph_objs/layout/slider/_step.py index b79f62574b5..c552265939e 100644 --- a/plotly/graph_objs/layout/slider/_step.py +++ b/plotly/graph_objs/layout/slider/_step.py @@ -12,9 +12,9 @@ def args(self): Sets the arguments values to be passed to the Plotly method set in `method` on slide. - The 'args' property is an info array that may be specified as a - list or tuple of up to 3 elements where: + The 'args' property is an info array that may be specified as: + * a list or tuple of up to 3 elements where: (0) The 'args[0]' property accepts values of any type (1) The 'args[1]' property accepts values of any type (2) The 'args[2]' property accepts values of any type diff --git a/plotly/graph_objs/layout/ternary/_aaxis.py b/plotly/graph_objs/layout/ternary/_aaxis.py index b5aa87d48f3..2c57b7f6ad5 100644 --- a/plotly/graph_objs/layout/ternary/_aaxis.py +++ b/plotly/graph_objs/layout/ternary/_aaxis.py @@ -852,7 +852,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1213,7 +1213,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1429,7 +1429,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/ternary/_baxis.py b/plotly/graph_objs/layout/ternary/_baxis.py index b7eaa4c10cf..0c6b2db14b5 100644 --- a/plotly/graph_objs/layout/ternary/_baxis.py +++ b/plotly/graph_objs/layout/ternary/_baxis.py @@ -852,7 +852,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1213,7 +1213,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1429,7 +1429,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/ternary/_caxis.py b/plotly/graph_objs/layout/ternary/_caxis.py index beb922028d2..445d0aa175a 100644 --- a/plotly/graph_objs/layout/ternary/_caxis.py +++ b/plotly/graph_objs/layout/ternary/_caxis.py @@ -852,7 +852,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1213,7 +1213,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1429,7 +1429,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/layout/ternary/_domain.py b/plotly/graph_objs/layout/ternary/_domain.py index 2393483f441..91f54c39bb8 100644 --- a/plotly/graph_objs/layout/ternary/_domain.py +++ b/plotly/graph_objs/layout/ternary/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this ternary subplot (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -82,9 +82,9 @@ def y(self): Sets the vertical domain of this ternary subplot (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py index 351411ce8ea..18e350ae5fd 100644 --- a/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py index 4be19773541..d87923b4118 100644 --- a/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py index 7c6d6014399..bc08483e738 100644 --- a/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/updatemenu/_button.py b/plotly/graph_objs/layout/updatemenu/_button.py index 463f50eb0f9..339c3e81143 100644 --- a/plotly/graph_objs/layout/updatemenu/_button.py +++ b/plotly/graph_objs/layout/updatemenu/_button.py @@ -12,9 +12,9 @@ def args(self): Sets the arguments values to be passed to the Plotly method set in `method` on click. - The 'args' property is an info array that may be specified as a - list or tuple of up to 3 elements where: + The 'args' property is an info array that may be specified as: + * a list or tuple of up to 3 elements where: (0) The 'args[0]' property accepts values of any type (1) The 'args[1]' property accepts values of any type (2) The 'args[2]' property accepts values of any type diff --git a/plotly/graph_objs/layout/xaxis/_rangeslider.py b/plotly/graph_objs/layout/xaxis/_rangeslider.py index c86e502e466..62822d9d8d2 100644 --- a/plotly/graph_objs/layout/xaxis/_rangeslider.py +++ b/plotly/graph_objs/layout/xaxis/_rangeslider.py @@ -179,9 +179,9 @@ def range(self): numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/xaxis/_tickformatstop.py b/plotly/graph_objs/layout/xaxis/_tickformatstop.py index 2c49994f806..5c6cea67c94 100644 --- a/plotly/graph_objs/layout/xaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/xaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py b/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py index 66b21485383..231e022da37 100644 --- a/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py +++ b/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py @@ -11,9 +11,9 @@ def range(self): """ Sets the range of this axis for the rangeslider. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property accepts values of any type (1) The 'range[1]' property accepts values of any type diff --git a/plotly/graph_objs/layout/yaxis/_tickformatstop.py b/plotly/graph_objs/layout/yaxis/_tickformatstop.py index b12b4c71971..478c05894c9 100644 --- a/plotly/graph_objs/layout/yaxis/_tickformatstop.py +++ b/plotly/graph_objs/layout/yaxis/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/mesh3d/_colorbar.py b/plotly/graph_objs/mesh3d/_colorbar.py index 81ab469ff7b..15e8548944d 100644 --- a/plotly/graph_objs/mesh3d/_colorbar.py +++ b/plotly/graph_objs/mesh3d/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py b/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py index d9edda29a4a..72b1e789df5 100644 --- a/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/parcoords/_dimension.py b/plotly/graph_objs/parcoords/_dimension.py index ade3fcd01fd..84c7472c45a 100644 --- a/plotly/graph_objs/parcoords/_dimension.py +++ b/plotly/graph_objs/parcoords/_dimension.py @@ -15,13 +15,19 @@ def constraintrange(self): you may give an array of arrays, where each inner array is `[fromValue, toValue]`. - The 'constraintrange' property is an info array that may be specified as a - list or tuple of up to 2 elements where: + The 'constraintrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'constraintrange[0]' property is a number and may be specified as: - An int or float (1) The 'constraintrange[1]' property is a number and may be specified as: - An int or float + + * a 2D list where: + (0) The 'constraintrange[i][0]' property is a number and may be specified as: + - An int or float + (1) The 'constraintrange[i][1]' property is a number and may be specified as: + - An int or float Returns ------- @@ -110,9 +116,9 @@ def range(self): Defaults to the `values` extent. Must be an array of `[fromValue, toValue]` with finite numbers as elements. - The 'range' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'range' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'range[0]' property is a number and may be specified as: - An int or float (1) The 'range[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/parcoords/_domain.py b/plotly/graph_objs/parcoords/_domain.py index 1a7a740a7d3..3bc60f0cc64 100644 --- a/plotly/graph_objs/parcoords/_domain.py +++ b/plotly/graph_objs/parcoords/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this parcoords trace (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -82,9 +82,9 @@ def y(self): Sets the vertical domain of this parcoords trace (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/parcoords/_line.py b/plotly/graph_objs/parcoords/_line.py index b3acb0b41ee..f4aad5e23cd 100644 --- a/plotly/graph_objs/parcoords/_line.py +++ b/plotly/graph_objs/parcoords/_line.py @@ -323,7 +323,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/parcoords/line/_colorbar.py b/plotly/graph_objs/parcoords/line/_colorbar.py index 03baafc8872..21e35b0014e 100644 --- a/plotly/graph_objs/parcoords/line/_colorbar.py +++ b/plotly/graph_objs/parcoords/line/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py b/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py index 68559612f1e..c217c6917bf 100644 --- a/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/pie/_domain.py b/plotly/graph_objs/pie/_domain.py index 10a31a9af82..a3a70d47f6d 100644 --- a/plotly/graph_objs/pie/_domain.py +++ b/plotly/graph_objs/pie/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this pie trace (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -81,9 +81,9 @@ def y(self): """ Sets the vertical domain of this pie trace (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/sankey/_domain.py b/plotly/graph_objs/sankey/_domain.py index 1f26477e126..f2059269833 100644 --- a/plotly/graph_objs/sankey/_domain.py +++ b/plotly/graph_objs/sankey/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this sankey trace (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -82,9 +82,9 @@ def y(self): Sets the vertical domain of this sankey trace (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/graph_objs/scatter/_marker.py b/plotly/graph_objs/scatter/_marker.py index 9a36e3af089..3dff4dd7c47 100644 --- a/plotly/graph_objs/scatter/_marker.py +++ b/plotly/graph_objs/scatter/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatter/marker/_colorbar.py b/plotly/graph_objs/scatter/marker/_colorbar.py index 22945008cd6..c04a08a1531 100644 --- a/plotly/graph_objs/scatter/marker/_colorbar.py +++ b/plotly/graph_objs/scatter/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py index 79fac230a28..ad1e618d346 100644 --- a/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scatter3d/_marker.py b/plotly/graph_objs/scatter3d/_marker.py index 1f374b6705e..385ecdc833b 100644 --- a/plotly/graph_objs/scatter3d/_marker.py +++ b/plotly/graph_objs/scatter3d/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatter3d/marker/_colorbar.py b/plotly/graph_objs/scatter3d/marker/_colorbar.py index c34822f1e73..0206f1bdcc7 100644 --- a/plotly/graph_objs/scatter3d/marker/_colorbar.py +++ b/plotly/graph_objs/scatter3d/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py index 2cb507c97bc..267a937ce3a 100644 --- a/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scattercarpet/_marker.py b/plotly/graph_objs/scattercarpet/_marker.py index 0dcf2797415..936a5d4e3e7 100644 --- a/plotly/graph_objs/scattercarpet/_marker.py +++ b/plotly/graph_objs/scattercarpet/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattercarpet/marker/_colorbar.py b/plotly/graph_objs/scattercarpet/marker/_colorbar.py index 87303ce2055..716aad02515 100644 --- a/plotly/graph_objs/scattercarpet/marker/_colorbar.py +++ b/plotly/graph_objs/scattercarpet/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py index 7a7ce7b557f..503c6adc843 100644 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scattergeo/_marker.py b/plotly/graph_objs/scattergeo/_marker.py index 76fbe614261..01cb7e5f899 100644 --- a/plotly/graph_objs/scattergeo/_marker.py +++ b/plotly/graph_objs/scattergeo/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattergeo/marker/_colorbar.py b/plotly/graph_objs/scattergeo/marker/_colorbar.py index 442a13001e9..9c54d7a3ad6 100644 --- a/plotly/graph_objs/scattergeo/marker/_colorbar.py +++ b/plotly/graph_objs/scattergeo/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py index a686870d8d4..f8c012e7b83 100644 --- a/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scattergl/_marker.py b/plotly/graph_objs/scattergl/_marker.py index f2b757a0568..e26b7d07143 100644 --- a/plotly/graph_objs/scattergl/_marker.py +++ b/plotly/graph_objs/scattergl/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattergl/marker/_colorbar.py b/plotly/graph_objs/scattergl/marker/_colorbar.py index 5ea81bfdcdf..fcfb7970f50 100644 --- a/plotly/graph_objs/scattergl/marker/_colorbar.py +++ b/plotly/graph_objs/scattergl/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py index f0ae5102311..e9ad6438995 100644 --- a/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scattermapbox/_marker.py b/plotly/graph_objs/scattermapbox/_marker.py index 3fb8421766c..cac2193d45b 100644 --- a/plotly/graph_objs/scattermapbox/_marker.py +++ b/plotly/graph_objs/scattermapbox/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattermapbox/marker/_colorbar.py b/plotly/graph_objs/scattermapbox/marker/_colorbar.py index b1af8018ed7..0343e8a2043 100644 --- a/plotly/graph_objs/scattermapbox/marker/_colorbar.py +++ b/plotly/graph_objs/scattermapbox/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py index a214004e9bd..88483bcb4d4 100644 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scatterpolar/_marker.py b/plotly/graph_objs/scatterpolar/_marker.py index 626d3bf34a2..76ecc82ba46 100644 --- a/plotly/graph_objs/scatterpolar/_marker.py +++ b/plotly/graph_objs/scatterpolar/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatterpolar/marker/_colorbar.py b/plotly/graph_objs/scatterpolar/marker/_colorbar.py index 95bfc5ce33d..105c11a0d9e 100644 --- a/plotly/graph_objs/scatterpolar/marker/_colorbar.py +++ b/plotly/graph_objs/scatterpolar/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py index 86c95cf0081..5b504e60f96 100644 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scatterpolargl/_marker.py b/plotly/graph_objs/scatterpolargl/_marker.py index b2a26cf9269..fb88c4bddbf 100644 --- a/plotly/graph_objs/scatterpolargl/_marker.py +++ b/plotly/graph_objs/scatterpolargl/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatterpolargl/marker/_colorbar.py b/plotly/graph_objs/scatterpolargl/marker/_colorbar.py index 6999786bf2c..6c9cf6d594a 100644 --- a/plotly/graph_objs/scatterpolargl/marker/_colorbar.py +++ b/plotly/graph_objs/scatterpolargl/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py index 067547f95ca..3dee6c4e4db 100644 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/scatterternary/_marker.py b/plotly/graph_objs/scatterternary/_marker.py index bea2b8dcc84..7319cdabe54 100644 --- a/plotly/graph_objs/scatterternary/_marker.py +++ b/plotly/graph_objs/scatterternary/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatterternary/marker/_colorbar.py b/plotly/graph_objs/scatterternary/marker/_colorbar.py index ac3d97e2b3e..b2501567b68 100644 --- a/plotly/graph_objs/scatterternary/marker/_colorbar.py +++ b/plotly/graph_objs/scatterternary/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1545,7 +1545,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py index a7081f9c28d..b3e75a8e2b6 100644 --- a/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/splom/_marker.py b/plotly/graph_objs/splom/_marker.py index c54c4b6a992..68b71c98dda 100644 --- a/plotly/graph_objs/splom/_marker.py +++ b/plotly/graph_objs/splom/_marker.py @@ -324,7 +324,7 @@ def colorbar(self): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/splom/marker/_colorbar.py b/plotly/graph_objs/splom/marker/_colorbar.py index fae03f9b495..47531711894 100644 --- a/plotly/graph_objs/splom/marker/_colorbar.py +++ b/plotly/graph_objs/splom/marker/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py index 4af7b19feb9..714501b68b4 100644 --- a/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/streamtube/_colorbar.py b/plotly/graph_objs/streamtube/_colorbar.py index 1c38e83de61..ff2c770218b 100644 --- a/plotly/graph_objs/streamtube/_colorbar.py +++ b/plotly/graph_objs/streamtube/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py b/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py index 9d38197d97e..235d0bffbd8 100644 --- a/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/surface/_colorbar.py b/plotly/graph_objs/surface/_colorbar.py index d8c4f964dc4..859f7c7816f 100644 --- a/plotly/graph_objs/surface/_colorbar.py +++ b/plotly/graph_objs/surface/_colorbar.py @@ -820,7 +820,7 @@ def tickprefix(self, val): @property def ticks(self): """ - Determines whether ticks are drawn or not. If **, this axis' + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. @@ -1314,7 +1314,7 @@ def _prop_descriptions(self): tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix @@ -1544,7 +1544,7 @@ def __init__( tickprefix Sets a tick label prefix. ticks - Determines whether ticks are drawn or not. If **, this + Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/graph_objs/surface/colorbar/_tickformatstop.py b/plotly/graph_objs/surface/colorbar/_tickformatstop.py index caeb9973ca9..6814e1577fc 100644 --- a/plotly/graph_objs/surface/colorbar/_tickformatstop.py +++ b/plotly/graph_objs/surface/colorbar/_tickformatstop.py @@ -13,9 +13,9 @@ def dtickrange(self): describe some zoom level, it is possible to omit "min" or "max" value by passing "null" - The 'dtickrange' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'dtickrange' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'dtickrange[0]' property accepts values of any type (1) The 'dtickrange[1]' property accepts values of any type diff --git a/plotly/graph_objs/table/_domain.py b/plotly/graph_objs/table/_domain.py index 5d1bc7e8bb0..877141a4156 100644 --- a/plotly/graph_objs/table/_domain.py +++ b/plotly/graph_objs/table/_domain.py @@ -56,9 +56,9 @@ def x(self): Sets the horizontal domain of this table trace (in plot fraction). - The 'x' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'x' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'x[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'x[1]' property is a number and may be specified as: @@ -82,9 +82,9 @@ def y(self): Sets the vertical domain of this table trace (in plot fraction). - The 'y' property is an info array that may be specified as a - list or tuple of 2 elements where: + The 'y' property is an info array that may be specified as: + * a list or tuple of 2 elements where: (0) The 'y[0]' property is a number and may be specified as: - An int or float in the interval [0, 1] (1) The 'y[1]' property is a number and may be specified as: diff --git a/plotly/validators/_histogram.py b/plotly/validators/_histogram.py index c5bd3914c02..d5f24c1dfa7 100644 --- a/plotly/validators/_histogram.py +++ b/plotly/validators/_histogram.py @@ -51,7 +51,7 @@ def __init__(self, plotly_name='histogram', parent_name='', **kwargs): respectively. histnorm Specifies the type of normalization used for - this histogram trace. If **, the span of each + this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the diff --git a/plotly/validators/_histogram2d.py b/plotly/validators/_histogram2d.py index 99c26426f1a..b1c9e973f87 100644 --- a/plotly/validators/_histogram2d.py +++ b/plotly/validators/_histogram2d.py @@ -67,7 +67,7 @@ def __init__(self, plotly_name='histogram2d', parent_name='', **kwargs): respectively. histnorm Specifies the type of normalization used for - this histogram trace. If **, the span of each + this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the diff --git a/plotly/validators/_histogram2dcontour.py b/plotly/validators/_histogram2dcontour.py index 9ff6f3dd430..57930f0be8e 100644 --- a/plotly/validators/_histogram2dcontour.py +++ b/plotly/validators/_histogram2dcontour.py @@ -80,7 +80,7 @@ def __init__( respectively. histnorm Specifies the type of normalization used for - this histogram trace. If **, the span of each + this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the diff --git a/plotly/validators/bar/marker/_colorbar.py b/plotly/validators/bar/marker/_colorbar.py index 561631e4fdf..50bf5529f2a 100644 --- a/plotly/validators/bar/marker/_colorbar.py +++ b/plotly/validators/bar/marker/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/barpolar/marker/_colorbar.py b/plotly/validators/barpolar/marker/_colorbar.py index 4debe96c3ad..a24b88b05e4 100644 --- a/plotly/validators/barpolar/marker/_colorbar.py +++ b/plotly/validators/barpolar/marker/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/choropleth/_colorbar.py b/plotly/validators/choropleth/_colorbar.py index 56dae5c1176..49971d25328 100644 --- a/plotly/validators/choropleth/_colorbar.py +++ b/plotly/validators/choropleth/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/cone/_colorbar.py b/plotly/validators/cone/_colorbar.py index 38b33db2894..1f5b1a02fc0 100644 --- a/plotly/validators/cone/_colorbar.py +++ b/plotly/validators/cone/_colorbar.py @@ -154,7 +154,7 @@ def __init__(self, plotly_name='colorbar', parent_name='cone', **kwargs): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/contour/_colorbar.py b/plotly/validators/contour/_colorbar.py index f362222836b..957982add26 100644 --- a/plotly/validators/contour/_colorbar.py +++ b/plotly/validators/contour/_colorbar.py @@ -156,7 +156,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/contourcarpet/_colorbar.py b/plotly/validators/contourcarpet/_colorbar.py index bddb856cb0a..0b0490ca9a3 100644 --- a/plotly/validators/contourcarpet/_colorbar.py +++ b/plotly/validators/contourcarpet/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/heatmap/_colorbar.py b/plotly/validators/heatmap/_colorbar.py index 78a98a77750..c12202bbd04 100644 --- a/plotly/validators/heatmap/_colorbar.py +++ b/plotly/validators/heatmap/_colorbar.py @@ -156,7 +156,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/heatmapgl/_colorbar.py b/plotly/validators/heatmapgl/_colorbar.py index dd795866c08..834a01d25c0 100644 --- a/plotly/validators/heatmapgl/_colorbar.py +++ b/plotly/validators/heatmapgl/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/histogram/_cumulative.py b/plotly/validators/histogram/_cumulative.py index 89c8da4a23f..dd8bbaddfd4 100644 --- a/plotly/validators/histogram/_cumulative.py +++ b/plotly/validators/histogram/_cumulative.py @@ -33,7 +33,7 @@ def __init__( and `centralbin` attributes to tune the accumulation method. Note: in this mode, the "density" `histnorm` settings behave the same - as their equivalents without "density": ** and + as their equivalents without "density": "" and "density" both rise to the number of data points, and "probability" and *probability density* both rise to the number of sample diff --git a/plotly/validators/histogram/marker/_colorbar.py b/plotly/validators/histogram/marker/_colorbar.py index 1f7c21405e5..c05ec755984 100644 --- a/plotly/validators/histogram/marker/_colorbar.py +++ b/plotly/validators/histogram/marker/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/histogram2d/_colorbar.py b/plotly/validators/histogram2d/_colorbar.py index 6e63356c3cb..03625ade5be 100644 --- a/plotly/validators/histogram2d/_colorbar.py +++ b/plotly/validators/histogram2d/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/histogram2dcontour/_colorbar.py b/plotly/validators/histogram2dcontour/_colorbar.py index b48eb3d3f5f..607131e993a 100644 --- a/plotly/validators/histogram2dcontour/_colorbar.py +++ b/plotly/validators/histogram2dcontour/_colorbar.py @@ -160,7 +160,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/_grid.py b/plotly/validators/layout/_grid.py index 991c18a1b43..48714662535 100644 --- a/plotly/validators/layout/_grid.py +++ b/plotly/validators/layout/_grid.py @@ -45,7 +45,7 @@ def __init__(self, plotly_name='grid', parent_name='layout', **kwargs): Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like - "xy" or "x3y2", or ** to leave that cell empty. + "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can @@ -55,8 +55,8 @@ def __init__(self, plotly_name='grid', parent_name='layout', **kwargs): Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or - ** to not put an x axis in that column. Entries - other than ** must be unique. Ignored if + "" to not put an x axis in that column. Entries + other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs. xgap @@ -67,15 +67,15 @@ def __init__(self, plotly_name='grid', parent_name='layout', **kwargs): xside Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. - *bottom plot* is the lowest plot that each x - axis is used in. "top" and *top plot* are + "bottom plot" is the lowest plot that each x + axis is used in. "top" and "top plot" are similar. yaxes Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or - ** to not put a y axis in that row. Entries - other than ** must be unique. Ignored if + "" to not put a y axis in that row. Entries + other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs. ygap diff --git a/plotly/validators/layout/_xaxis.py b/plotly/validators/layout/_xaxis.py index 55567d81650..aec261dd92a 100644 --- a/plotly/validators/layout/_xaxis.py +++ b/plotly/validators/layout/_xaxis.py @@ -330,7 +330,7 @@ def __init__(self, plotly_name='xaxis', parent_name='layout', **kwargs): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/_yaxis.py b/plotly/validators/layout/_yaxis.py index 1920d096182..bcf40779346 100644 --- a/plotly/validators/layout/_yaxis.py +++ b/plotly/validators/layout/_yaxis.py @@ -324,7 +324,7 @@ def __init__(self, plotly_name='yaxis', parent_name='layout', **kwargs): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/polar/_angularaxis.py b/plotly/validators/layout/polar/_angularaxis.py index df41ba6600e..f7714adacc0 100644 --- a/plotly/validators/layout/polar/_angularaxis.py +++ b/plotly/validators/layout/polar/_angularaxis.py @@ -210,7 +210,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/polar/_radialaxis.py b/plotly/validators/layout/polar/_radialaxis.py index 0cace96f2de..dde73d968ef 100644 --- a/plotly/validators/layout/polar/_radialaxis.py +++ b/plotly/validators/layout/polar/_radialaxis.py @@ -231,7 +231,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/scene/_xaxis.py b/plotly/validators/layout/scene/_xaxis.py index e2cd31c5000..dadb5368915 100644 --- a/plotly/validators/layout/scene/_xaxis.py +++ b/plotly/validators/layout/scene/_xaxis.py @@ -239,7 +239,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/scene/_yaxis.py b/plotly/validators/layout/scene/_yaxis.py index d7317af308f..30a2dde3750 100644 --- a/plotly/validators/layout/scene/_yaxis.py +++ b/plotly/validators/layout/scene/_yaxis.py @@ -239,7 +239,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/scene/_zaxis.py b/plotly/validators/layout/scene/_zaxis.py index f67c01c8a6e..d5b021bc936 100644 --- a/plotly/validators/layout/scene/_zaxis.py +++ b/plotly/validators/layout/scene/_zaxis.py @@ -239,7 +239,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/ternary/_aaxis.py b/plotly/validators/layout/ternary/_aaxis.py index 8be4a9137f3..4495c8b2189 100644 --- a/plotly/validators/layout/ternary/_aaxis.py +++ b/plotly/validators/layout/ternary/_aaxis.py @@ -174,7 +174,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/ternary/_baxis.py b/plotly/validators/layout/ternary/_baxis.py index ad298abfea7..9d17deb3949 100644 --- a/plotly/validators/layout/ternary/_baxis.py +++ b/plotly/validators/layout/ternary/_baxis.py @@ -174,7 +174,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/layout/ternary/_caxis.py b/plotly/validators/layout/ternary/_caxis.py index aa9836599f8..20a506bc3af 100644 --- a/plotly/validators/layout/ternary/_caxis.py +++ b/plotly/validators/layout/ternary/_caxis.py @@ -174,7 +174,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/mesh3d/_colorbar.py b/plotly/validators/mesh3d/_colorbar.py index 939d5923c34..ea59e7887b3 100644 --- a/plotly/validators/mesh3d/_colorbar.py +++ b/plotly/validators/mesh3d/_colorbar.py @@ -154,7 +154,7 @@ def __init__(self, plotly_name='colorbar', parent_name='mesh3d', **kwargs): Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/parcoords/line/_colorbar.py b/plotly/validators/parcoords/line/_colorbar.py index f55d53fd74d..277a3cbf38b 100644 --- a/plotly/validators/parcoords/line/_colorbar.py +++ b/plotly/validators/parcoords/line/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scatter/marker/_colorbar.py b/plotly/validators/scatter/marker/_colorbar.py index f3f8d8c418a..7525230df2b 100644 --- a/plotly/validators/scatter/marker/_colorbar.py +++ b/plotly/validators/scatter/marker/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scatter3d/marker/_colorbar.py b/plotly/validators/scatter3d/marker/_colorbar.py index 60a7f691218..7fedf3fcdf3 100644 --- a/plotly/validators/scatter3d/marker/_colorbar.py +++ b/plotly/validators/scatter3d/marker/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scattercarpet/marker/_colorbar.py b/plotly/validators/scattercarpet/marker/_colorbar.py index 660bd16e0fc..83da927566e 100644 --- a/plotly/validators/scattercarpet/marker/_colorbar.py +++ b/plotly/validators/scattercarpet/marker/_colorbar.py @@ -160,7 +160,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scattergeo/marker/_colorbar.py b/plotly/validators/scattergeo/marker/_colorbar.py index a2f882da078..46f43e20c0e 100644 --- a/plotly/validators/scattergeo/marker/_colorbar.py +++ b/plotly/validators/scattergeo/marker/_colorbar.py @@ -160,7 +160,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scattergl/marker/_colorbar.py b/plotly/validators/scattergl/marker/_colorbar.py index 189ed55360b..6b6036da068 100644 --- a/plotly/validators/scattergl/marker/_colorbar.py +++ b/plotly/validators/scattergl/marker/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scattermapbox/marker/_colorbar.py b/plotly/validators/scattermapbox/marker/_colorbar.py index cdc6b01b190..5f00094b90e 100644 --- a/plotly/validators/scattermapbox/marker/_colorbar.py +++ b/plotly/validators/scattermapbox/marker/_colorbar.py @@ -160,7 +160,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scatterpolar/marker/_colorbar.py b/plotly/validators/scatterpolar/marker/_colorbar.py index eee5a09d210..d707d30138d 100644 --- a/plotly/validators/scatterpolar/marker/_colorbar.py +++ b/plotly/validators/scatterpolar/marker/_colorbar.py @@ -160,7 +160,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scatterpolargl/marker/_colorbar.py b/plotly/validators/scatterpolargl/marker/_colorbar.py index f392aa5bc6d..982ee891d44 100644 --- a/plotly/validators/scatterpolargl/marker/_colorbar.py +++ b/plotly/validators/scatterpolargl/marker/_colorbar.py @@ -160,7 +160,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/scatterternary/marker/_colorbar.py b/plotly/validators/scatterternary/marker/_colorbar.py index ecdc23a29c3..ddb4c95d142 100644 --- a/plotly/validators/scatterternary/marker/_colorbar.py +++ b/plotly/validators/scatterternary/marker/_colorbar.py @@ -160,7 +160,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/splom/marker/_colorbar.py b/plotly/validators/splom/marker/_colorbar.py index 365ff1347e6..5012f3113df 100644 --- a/plotly/validators/splom/marker/_colorbar.py +++ b/plotly/validators/splom/marker/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/streamtube/_colorbar.py b/plotly/validators/streamtube/_colorbar.py index f4a5dfab51e..730b5b338e6 100644 --- a/plotly/validators/streamtube/_colorbar.py +++ b/plotly/validators/streamtube/_colorbar.py @@ -157,7 +157,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix diff --git a/plotly/validators/surface/_colorbar.py b/plotly/validators/surface/_colorbar.py index 96c56d73b21..92a3dec6bdc 100644 --- a/plotly/validators/surface/_colorbar.py +++ b/plotly/validators/surface/_colorbar.py @@ -156,7 +156,7 @@ def __init__( Sets a tick label prefix. ticks Determines whether ticks are drawn or not. If - **, this axis' ticks are not drawn. If + "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines. ticksuffix From e40b12af1f983eaf4b463b6e69abad04dc8e25ad Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Wed, 17 Oct 2018 19:22:14 -0400 Subject: [PATCH 2/5] Fix existing InfoArrayValidator tests There were some duplicated test method names causing some of the tests to not run. --- .../validators/test_infoarray_validator.py | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/_plotly_utils/tests/validators/test_infoarray_validator.py b/_plotly_utils/tests/validators/test_infoarray_validator.py index 11fd09860e1..3b83ab24fd5 100644 --- a/_plotly_utils/tests/validators/test_infoarray_validator.py +++ b/_plotly_utils/tests/validators/test_infoarray_validator.py @@ -46,7 +46,7 @@ def test_validator_rejection_any2_type(val, validator_any2): with pytest.raises(ValueError) as validation_failure: validator_any2.validate_coerce(val) - assert 'must be a list or tuple.' in str(validation_failure.value) + assert 'Invalid value' in str(validation_failure.value) # ### Rejection by length ### @@ -80,7 +80,7 @@ def test_validator_rejection_number3_length(val, validator_number3): with pytest.raises(ValueError) as validation_failure: validator_number3.validate_coerce(val) - assert 'must be a list or tuple of length 3.' in str(validation_failure.value) + assert 'Invalid value' in str(validation_failure.value) # ### Rejection by element type ### @@ -89,11 +89,11 @@ def test_validator_rejection_number3_length(val, validator_number3): ((0.1, set(), 0.99), 1), ([[], '2', {}], 0) ]) -def test_validator_rejection_number3_length(val, first_invalid_ind, validator_number3): +def test_validator_rejection_number3_element_type(val, first_invalid_ind, validator_number3): with pytest.raises(ValueError) as validation_failure: validator_number3.validate_coerce(val) - assert 'The prop[%d] property of parent must be a number.' % first_invalid_ind in str(validation_failure.value) + assert 'Invalid value' in str(validation_failure.value) # ### Rejection by element value ### @@ -103,12 +103,11 @@ def test_validator_rejection_number3_length(val, first_invalid_ind, validator_nu ((0.1, -0.4, 0.99), 1), ([-1, 1, 0], 0) ]) -def test_validator_rejection_number3_length(val, first_invalid_ind, validator_number3): +def test_validator_rejection_number3_element_value(val, first_invalid_ind, validator_number3): with pytest.raises(ValueError) as validation_failure: validator_number3.validate_coerce(val) - assert ('The prop[%d] property of parent must be in the range [0, 1]' % first_invalid_ind - in str(validation_failure.value)) + assert ('in the interval [0, 1]' in str(validation_failure.value)) # Number3 Tests (free_length=True) @@ -130,7 +129,7 @@ def test_validator_acceptance_number3_free(val, validator_number3_free): @pytest.mark.parametrize('val', [ 'Not a list', 123, set(), {} ]) -def test_validator_rejection_any2_type(val, validator_number3_free): +def test_validator_rejection_number3_free_element_type(val, validator_number3_free): with pytest.raises(ValueError) as validation_failure: validator_number3_free.validate_coerce(val) @@ -154,7 +153,7 @@ def test_validator_rejection_number3_free_length(val, validator_number3_free): ((0.1, set()), 1), ([[]], 0) ]) -def test_validator_rejection_number3_length(val, first_invalid_ind, validator_number3_free): +def test_validator_rejection_number3_free_element_value(val, first_invalid_ind, validator_number3_free): with pytest.raises(ValueError) as validation_failure: validator_number3_free.validate_coerce(val) From 6896deb031dd9b45175d016f84f2fb00d04e80fc Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Fri, 19 Oct 2018 19:14:19 -0400 Subject: [PATCH 3/5] Finished working implementation of new info_array validator But it really needs some cleanup --- _plotly_utils/basevalidators.py | 118 +++++- .../validators/test_infoarray_validator.py | 342 +++++++++++++++++- 2 files changed, 445 insertions(+), 15 deletions(-) diff --git a/_plotly_utils/basevalidators.py b/_plotly_utils/basevalidators.py index d3f1bec9b3d..65a9aff5d18 100644 --- a/_plotly_utils/basevalidators.py +++ b/_plotly_utils/basevalidators.py @@ -219,7 +219,7 @@ def description(self): """ raise NotImplementedError() - def raise_invalid_val(self, v): + def raise_invalid_val(self, v, name=None): """ Helper method to raise an informative exception when an invalid value is passed to the validate_coerce method. @@ -228,6 +228,9 @@ def raise_invalid_val(self, v): ---------- v : Value that was input to validate_coerce and could not be coerced + name : str or None + Property name to use in error message, if None (default) use the + plotly_name property Raises ------- ValueError @@ -237,7 +240,7 @@ def raise_invalid_val(self, v): Received value: {v} {valid_clr_desc}""".format( - name=self.plotly_name, + name=name if name else self.plotly_name, pname=self.parent_name, typ=type_str(v), v=repr(v), @@ -1737,19 +1740,95 @@ def build_validator(validator_info, plotly_name, parent_name): return validator_class( plotly_name=plotly_name, parent_name=parent_name, **kwargs) + def validator_coerce_1d_array(self, row, row_ind): + """ + Helper to perform validate_coerce on the elements of a list that has + already been confirmed to contain the same number of elements as + there are items. + + This method updates the row elements in place + """ + for c, validator in enumerate(self.item_validators): + orig_name = validator.plotly_name + validator.plotly_name = "{name}[{r}][{c}]".format( + name=self.plotly_name, r=row_ind, c=c) + try: + row[c] = validator.validate_coerce(row[c]) + finally: + validator.plotly_name = orig_name + def validate_coerce(self, v): if v is None: # Pass None through - pass + return None elif not is_array(v): self.raise_invalid_val(v) + + # Save off original v value to use in error reporting + orig_v = v + + # Convert everything into nested lists + # This way we don't need to worry about nested numpy arrays + v = to_scalar_or_list(v) + + is_v_2d = v and is_array(v[0]) + + if is_v_2d: + if self.dimensions == 1: + self.raise_invalid_val(orig_v) + else: # self.dimensions is '1-2' or 2 + if is_array(self.items): + # e.g. parcoords.dimensions.constraintrange + # check that all items are there for each nested element + for i, row in enumerate(v): + # Check row length + if not is_array(row) or len(row) != len(self.items): + self.raise_invalid_val( + orig_v[i], '{name}[{i}]'.format( + i=i, + name=self.plotly_name)) + + self.validator_coerce_1d_array(row, i) + else: + # e.g. layout.grid.subplots + # check that all elements match individual validator + validator = self.item_validators[0] + for i, row in enumerate(v): + if not is_array(row): + self.raise_invalid_val( + orig_v[i], '{name}[{i}]'.format( + i=i, + name=self.plotly_name)) + + for j, el in enumerate(row): + orig_name = validator.plotly_name + validator.plotly_name = "{name}[{i}][{j}]".format( + name=self.plotly_name, i=i, j=j) + try: + row[j] = validator.validate_coerce(el) + finally: + validator.plotly_name = orig_name + elif v and self.dimensions == 2: + self.raise_invalid_val( + orig_v[0], '{name}[0]'.format(name=self.plotly_name)) + elif not is_array(self.items): + # e.g. layout.grid.xaxes + validator = self.item_validators[0] + for i, el in enumerate(v): + orig_name = validator.plotly_name + validator.plotly_name = "{name}[{i}]".format( + name=self.plotly_name, i=i) + try: + v[i] = validator.validate_coerce(el) + finally: + validator.plotly_name = orig_name + elif not self.free_length and len(v) != len(self.item_validators): - self.raise_invalid_val(v) + self.raise_invalid_val(orig_v) elif self.free_length and len(v) > len(self.item_validators): - self.raise_invalid_val(v) + self.raise_invalid_val(orig_v) else: # We have an array of the correct length - v = to_scalar_or_list(v) for i, (el, validator) in enumerate(zip(v, self.item_validators)): # Validate coerce elements v[i] = validator.validate_coerce(el) @@ -1760,13 +1839,28 @@ def present(self, v): if v is None: return None else: - # Call present on each of the item validators - for i, (el, validator) in enumerate(zip(v, self.item_validators)): - # Validate coerce elements - v[i] = validator.present(el) + if (self.dimensions == 2 or + self.dimensions == '1-2' and v and is_array(v[0])): - # Return tuple form of - return tuple(v) + # 2D case + v = copy.deepcopy(v) + for row in v: + for i, (el, validator) in enumerate( + zip(row, self.item_validators)): + row[i] = validator.present(el) + + return tuple(tuple(row) for row in v) + else: + # 1D case + v = copy.copy(v) + # Call present on each of the item validators + for i, (el, validator) in enumerate( + zip(v, self.item_validators)): + # Validate coerce elements + v[i] = validator.present(el) + + # Return tuple form of + return tuple(v) class LiteralValidator(BaseValidator): diff --git a/_plotly_utils/tests/validators/test_infoarray_validator.py b/_plotly_utils/tests/validators/test_infoarray_validator.py index 3b83ab24fd5..1db6ef30a14 100644 --- a/_plotly_utils/tests/validators/test_infoarray_validator.py +++ b/_plotly_utils/tests/validators/test_infoarray_validator.py @@ -26,6 +26,42 @@ def validator_number3_free(): {'valType': 'number', 'min': 0, 'max': 1}], free_length=True) +@pytest.fixture() +def validator_number2_2d(): + return InfoArrayValidator('prop', 'parent', items=[ + {'valType': 'number', 'min': 0, 'max': 1}, + {'valType': 'number', 'min': 0, 'max': 1}], + free_length=True, + dimensions=2) + + +@pytest.fixture() +def validator_number2_12d(): + return InfoArrayValidator('prop', 'parent', items=[ + {'valType': 'number', 'min': 0, 'max': 1}, + {'valType': 'number', 'min': 0, 'max': 1}], + free_length=True, + dimensions='1-2') + + +@pytest.fixture() +def validator_number_free_1d(): + return InfoArrayValidator('prop', 'parent', + items={'valType': 'number', + 'min': 0, 'max': 1}, + free_length=True, + dimensions=1) + + +@pytest.fixture() +def validator_number_free_2d(): + return InfoArrayValidator('prop', 'parent', + items={'valType': 'number', + 'min': 0, 'max': 1}, + free_length=True, + dimensions=2) + + # Any2 Tests # ---------- # ### Acceptance ### @@ -129,7 +165,7 @@ def test_validator_acceptance_number3_free(val, validator_number3_free): @pytest.mark.parametrize('val', [ 'Not a list', 123, set(), {} ]) -def test_validator_rejection_number3_free_element_type(val, validator_number3_free): +def test_validator_rejection_number3_free_type(val, validator_number3_free): with pytest.raises(ValueError) as validation_failure: validator_number3_free.validate_coerce(val) @@ -151,12 +187,312 @@ def test_validator_rejection_number3_free_length(val, validator_number3_free): @pytest.mark.parametrize('val,first_invalid_ind', [ ([1, 0, '0.5'], 2), ((0.1, set()), 1), - ([[]], 0) + ([{}], 0) +]) +def test_validator_rejection_number3_free_element_type(val, first_invalid_ind, validator_number3_free): + with pytest.raises(ValueError) as validation_failure: + validator_number3_free.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# ### Rejection by element value ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([1, 0, -0.5], 2), + ((0.1, 2), 1), + ([99], 0) ]) def test_validator_rejection_number3_free_element_value(val, first_invalid_ind, validator_number3_free): with pytest.raises(ValueError) as validation_failure: validator_number3_free.validate_coerce(val) assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" - .format(typ= type_str(val[first_invalid_ind]), + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# Number2 2D +# ---------- +# ### Acceptance ### +@pytest.mark.parametrize('val', [ + [], + [[1, 0]], + [(0.1, 0.99)], + np.array([[0.1, 0.99]]), + [np.array([0.1, 0.4]), [0.2, 0], (0.9, 0.5)] +]) +def test_validator_acceptance_number2_2d(val, validator_number2_2d): + coerce_val = validator_number2_2d.validate_coerce(val) + assert coerce_val == list((list(row) for row in val)) + expected = tuple([tuple(e) for e in val]) + assert validator_number2_2d.present(coerce_val) == expected + + +# ### Rejection by type ### +@pytest.mark.parametrize('val', [ + 'Not a list', 123, set(), {}, +]) +def test_validator_rejection_number2_2d_type(val, validator_number2_2d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_2d.validate_coerce(val) + + assert 'Invalid value' in str(validation_failure.value) + + +# ### Rejection by element type ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([[1, 0], [0.2, 0.4], 'string'], 2), + ([[0.1, 0.7], set()], 1), + (['bogus'], 0) +]) +def test_validator_rejection_number2_2d_element_type(val, first_invalid_ind, validator_number2_2d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_2d.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# ### Rejection by element length ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([[1, 0], [0.2, 0.4], [0.2]], 2), + ([[0.1, 0.7], [0, .1, .4]], 1), + ([[]], 0) +]) +def test_validator_rejection_number2_2d_element_length(val, first_invalid_ind, validator_number2_2d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_2d.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# ### Rejection by element value ### +@pytest.mark.parametrize('val,invalid_inds', [ + ([[1, 0], [0.2, 0.4], [0.2, 1.2]], [2, 1]), + ([[0.1, 0.7], [-2, .1]], [1, 0]), + ([[99, 0.3]], [0, 0]) +]) +def test_validator_rejection_number2_2d_element_value(val, invalid_inds, validator_number2_2d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_2d.validate_coerce(val) + + invalid_val = val[invalid_inds[0]][invalid_inds[1]] + invalid_name = 'prop[{}][{}]'.format(*invalid_inds) + assert ("Invalid value of type {typ} received for the '{invalid_name}' property of parent" + .format(typ=type_str(invalid_val), + invalid_name=invalid_name)) in str(validation_failure.value) + + +# Number2 '1-2' +# ------------- +# ### Acceptance ### +@pytest.mark.parametrize('val', [ + [], + [1, 0], + (0.1, 0.99), + np.array([0.1, 0.99]) +]) +def test_validator_acceptance_number2_12d_1d(val, validator_number2_12d): + coerce_val = validator_number2_12d.validate_coerce(val) + assert coerce_val == list(val) + expected = tuple(val) + assert validator_number2_12d.present(coerce_val) == expected + + +@pytest.mark.parametrize('val', [ + [], + [[1, 0]], + [(0.1, 0.99)], + np.array([[0.1, 0.99]]), + [np.array([0.1, 0.4]), [0.2, 0], (0.9, 0.5)] +]) +def test_validator_acceptance_number2_12d_2d(val, validator_number2_12d): + coerce_val = validator_number2_12d.validate_coerce(val) + assert coerce_val == list((list(row) for row in val)) + expected = tuple([tuple(e) for e in val]) + assert validator_number2_12d.present(coerce_val) == expected + + +# ### Rejection by type / length### +@pytest.mark.parametrize('val', [ + 'Not a list', 123, set(), {}, [0.1, 0.3, 0.2] +]) +def test_validator_rejection_number2_12d_type(val, validator_number2_12d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_12d.validate_coerce(val) + + assert 'Invalid value' in str(validation_failure.value) + + +# ### Rejection by element type 2D ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([[1, 0], [0.2, 0.4], 'string'], 2), + ([[0.1, 0.7], set()], 1), + (['bogus'], 0) +]) +def test_validator_rejection_number2_12d_element_type(val, first_invalid_ind, validator_number2_12d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_12d.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# ### Rejection by element length ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([[1, 0], [0.2, 0.4], [0.2]], 2), + ([[0.1, 0.7], [0, .1, .4]], 1), + ([[]], 0) +]) +def test_validator_rejection_number2_12d_element_length(val, first_invalid_ind, validator_number2_12d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_12d.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# ### Rejection by element value ### +@pytest.mark.parametrize('val,invalid_inds', [ + ([[1, 0], [0.2, 0.4], [0.2, 1.2]], [2, 1]), + ([[0.1, 0.7], [-2, .1]], [1, 0]), + ([[99, 0.3]], [0, 0]), + ([0.1, 1.2], [1]), + ([-0.1, 0.99], [0]), +]) +def test_validator_rejection_number2_12d_element_value(val, invalid_inds, validator_number2_12d): + with pytest.raises(ValueError) as validation_failure: + validator_number2_12d.validate_coerce(val) + + if len(invalid_inds) > 1: + invalid_val = val[invalid_inds[0]][invalid_inds[1]] + invalid_name = 'prop[{}][{}]'.format(*invalid_inds) + else: + invalid_val = val[invalid_inds[0]] + invalid_name = 'prop[{}]'.format(*invalid_inds) + + assert ("Invalid value of type {typ} received for the '{invalid_name}' property of parent" + .format(typ=type_str(invalid_val), + invalid_name=invalid_name)) in str(validation_failure.value) + + +# Number free 1D +# -------------- +@pytest.mark.parametrize('val', [ + [], + [1, 0], + (0.1, 0.99, 0.4), + np.array([0.1, 0.4, 0.5, 0.1, 0.6, 0.99]) +]) +def test_validator_acceptance_number_free_1d(val, validator_number_free_1d): + coerce_val = validator_number_free_1d.validate_coerce(val) + assert coerce_val == list(val) + expected = tuple(val) + assert validator_number_free_1d.present(coerce_val) == expected + + +# ### Rejection by type ### +@pytest.mark.parametrize('val', [ + 'Not a list', 123, set(), {}, +]) +def test_validator_rejection_number_free_1d_type(val, validator_number_free_1d): + with pytest.raises(ValueError) as validation_failure: + validator_number_free_1d.validate_coerce(val) + + assert 'Invalid value' in str(validation_failure.value) + + +# ### Rejection by element type ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([1, 0, 0.3, 0.5, '0.5', 0.2], 4), + ((0.1, set()), 1), + ([{}], 0) +]) +def test_validator_rejection_number_free_1d_element_type(val, first_invalid_ind, validator_number_free_1d): + with pytest.raises(ValueError) as validation_failure: + validator_number_free_1d.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# ### Rejection by element value ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([1, 0, 0.3, 0.999, -0.5], 4), + ((0.1, 2, 0.8), 1), + ([99, 0.3], 0) +]) +def test_validator_rejection_number_free_1d_element_value(val, first_invalid_ind, validator_number_free_1d): + with pytest.raises(ValueError) as validation_failure: + validator_number_free_1d.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# Number free 2D +# -------------- +@pytest.mark.parametrize('val', [ + [], + [[1, 0]], + [(0.1, 0.99)], + np.array([[0.1, 0.99]]), + [np.array([0.1, 0.4]), [0.2, 0], (0.9, 0.5)] +]) +def test_validator_acceptance_number_free_2d(val, validator_number_free_2d): + coerce_val = validator_number_free_2d.validate_coerce(val) + assert coerce_val == list((list(row) for row in val)) + expected = tuple([tuple(e) for e in val]) + assert validator_number_free_2d.present(coerce_val) == expected + + +# ### Rejection by type ### +@pytest.mark.parametrize('val', [ + 'Not a list', 123, set(), {}, +]) +def test_validator_rejection_number_free_2d_type(val, validator_number_free_2d): + with pytest.raises(ValueError) as validation_failure: + validator_number_free_2d.validate_coerce(val) + + assert 'Invalid value' in str(validation_failure.value) + + +# ### Rejection by element type ### +@pytest.mark.parametrize('val,first_invalid_ind', [ + ([[1, 0], [0.2, 0.4], 'string'], 2), + ([[0.1, 0.7], set()], 1), + (['bogus'], 0) +]) +def test_validator_rejection_number_free_2d_element_type(val, first_invalid_ind, validator_number_free_2d): + with pytest.raises(ValueError) as validation_failure: + validator_number_free_2d.validate_coerce(val) + + assert ("Invalid value of type {typ} received for the 'prop[{first_invalid_ind}]' property of parent" + .format(typ=type_str(val[first_invalid_ind]), + first_invalid_ind=first_invalid_ind)) in str(validation_failure.value) + + +# ### Rejection by element value ### +@pytest.mark.parametrize('val,invalid_inds', [ + ([[1, 0], [0.2, 0.4], [0.2, 1.2]], [2, 1]), + ([[0.1, 0.7], [-2, .1]], [1, 0]), + ([[99, 0.3]], [0, 0]) +]) +def test_validator_rejection_number_free_2d_element_value(val, invalid_inds, validator_number_free_2d): + with pytest.raises(ValueError) as validation_failure: + validator_number_free_2d.validate_coerce(val) + + invalid_val = val[invalid_inds[0]][invalid_inds[1]] + invalid_name = 'prop[{}][{}]'.format(*invalid_inds) + assert ("Invalid value of type {typ} received for the '{invalid_name}' property of parent" + .format(typ=type_str(invalid_val), + invalid_name=invalid_name)) in str(validation_failure.value) From 0cec3fce37c1c2f2fb066a059ae274614277fa30 Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Sun, 21 Oct 2018 06:47:14 -0400 Subject: [PATCH 4/5] Added test to instantiate all graph_objs --- .../test_instantiate_hierarchy.py | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py diff --git a/plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py b/plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py new file mode 100644 index 00000000000..7ac1b82fa3b --- /dev/null +++ b/plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py @@ -0,0 +1,29 @@ +from __future__ import absolute_import +from unittest import TestCase +import os +import importlib +import inspect + +from plotly.basedatatypes import BasePlotlyType, BaseFigure +datatypes_root = 'plotly/graph_objs' +datatype_modules = [dirpath.replace('/', '.') + for dirpath, _, _ in os.walk(datatypes_root) + if not dirpath.endswith('__pycache__')] + + +class HierarchyTest(TestCase): + + def test_construct_datatypes(self): + for datatypes_module in datatype_modules: + module = importlib.import_module(datatypes_module) + for name, obj in inspect.getmembers(module, inspect.isclass): + v = obj() + if obj.__module__ == 'plotly.graph_objs._deprecations': + self.assertTrue( + isinstance(v, list) or isinstance(v, dict) + ) + obj() + elif name in ('Figure', 'FigureWidget'): + self.assertIsInstance(v, BaseFigure) + else: + self.assertIsInstance(v, BasePlotlyType) From ab04ac9875176c0a346c3eabb0082b4bd79ef2e4 Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Mon, 22 Oct 2018 07:03:32 -0400 Subject: [PATCH 5/5] Cleanup / refactor infoarray validator implementation --- _plotly_utils/basevalidators.py | 111 ++++++++++-------- .../validators/test_infoarray_validator.py | 6 + 2 files changed, 70 insertions(+), 47 deletions(-) diff --git a/_plotly_utils/basevalidators.py b/_plotly_utils/basevalidators.py index 65a9aff5d18..56a5f8ba119 100644 --- a/_plotly_utils/basevalidators.py +++ b/_plotly_utils/basevalidators.py @@ -219,7 +219,7 @@ def description(self): """ raise NotImplementedError() - def raise_invalid_val(self, v, name=None): + def raise_invalid_val(self, v, inds=None): """ Helper method to raise an informative exception when an invalid value is passed to the validate_coerce method. @@ -228,19 +228,25 @@ def raise_invalid_val(self, v, name=None): ---------- v : Value that was input to validate_coerce and could not be coerced - name : str or None - Property name to use in error message, if None (default) use the - plotly_name property + inds: list of int or None (default) + Indexes to display after property name. e.g. if self.plotly_name + is 'prop' and inds=[2, 1] then the name in the validation error + message will be 'prop[2][1]` Raises ------- ValueError """ + name = self.plotly_name + if inds: + for i in inds: + name += '[' + str(i) + ']' + raise ValueError(""" Invalid value of type {typ} received for the '{name}' property of {pname} Received value: {v} {valid_clr_desc}""".format( - name=name if name else self.plotly_name, + name=name, pname=self.parent_name, typ=type_str(v), v=repr(v), @@ -1740,22 +1746,45 @@ def build_validator(validator_info, plotly_name, parent_name): return validator_class( plotly_name=plotly_name, parent_name=parent_name, **kwargs) - def validator_coerce_1d_array(self, row, row_ind): + def validate_element_with_indexed_name(self, val, validator, inds): """ - Helper to perform validate_coerce on the elements of a list that has - already been confirmed to contain the same number of elements as - there are items. + Helper to add indexes to a validator's name, call validate_coerce on + a value, then restore the original validator name. + + This makes sure that if a validation error message is raised, the + property name the user sees includes the index(es) of the offending + element. - This method updates the row elements in place + Parameters + ---------- + val: + A value to be validated + validator + A validator + inds + List of one or more non-negative integers that represent the + nested index of the value being validated + Returns + ------- + val + validated value + + Raises + ------ + ValueError + if val fails validation """ - for c, validator in enumerate(self.item_validators): - orig_name = validator.plotly_name - validator.plotly_name = "{name}[{r}][{c}]".format( - name=self.plotly_name, r=row_ind, c=c) - try: - row[c] = validator.validate_coerce(row[c]) - finally: - validator.plotly_name = orig_name + orig_name = validator.plotly_name + new_name = self.plotly_name + for i in inds: + new_name += '[' + str(i) + ']' + validator.plotly_name = new_name + try: + val = validator.validate_coerce(val) + finally: + validator.plotly_name = orig_name + + return val def validate_coerce(self, v): if v is None: @@ -1778,57 +1807,45 @@ def validate_coerce(self, v): self.raise_invalid_val(orig_v) else: # self.dimensions is '1-2' or 2 if is_array(self.items): - # e.g. parcoords.dimensions.constraintrange + # e.g. 2D list as parcoords.dimensions.constraintrange # check that all items are there for each nested element for i, row in enumerate(v): # Check row length if not is_array(row) or len(row) != len(self.items): - self.raise_invalid_val( - orig_v[i], '{name}[{i}]'.format( - i=i, - name=self.plotly_name)) + self.raise_invalid_val(orig_v[i], [i]) - self.validator_coerce_1d_array(row, i) + for j, validator in enumerate(self.item_validators): + row[j] = self.validate_element_with_indexed_name( + v[i][j], validator, [i, j]) else: - # e.g. layout.grid.subplots + # e.g. 2D list as layout.grid.subplots # check that all elements match individual validator validator = self.item_validators[0] for i, row in enumerate(v): if not is_array(row): - self.raise_invalid_val( - orig_v[i], '{name}[{i}]'.format( - i=i, - name=self.plotly_name)) + self.raise_invalid_val(orig_v[i], [i]) for j, el in enumerate(row): - orig_name = validator.plotly_name - validator.plotly_name = "{name}[{i}][{j}]".format( - name=self.plotly_name, i=i, j=j) - try: - row[j] = validator.validate_coerce(el) - finally: - validator.plotly_name = orig_name + row[j] = self.validate_element_with_indexed_name( + el, validator, [i, j]) elif v and self.dimensions == 2: - self.raise_invalid_val( - orig_v[0], '{name}[0]'.format(name=self.plotly_name)) + # e.g. 1D list passed as layout.grid.subplots + self.raise_invalid_val(orig_v[0], [0]) elif not is_array(self.items): - # e.g. layout.grid.xaxes + # e.g. 1D list passed as layout.grid.xaxes validator = self.item_validators[0] for i, el in enumerate(v): - orig_name = validator.plotly_name - validator.plotly_name = "{name}[{i}]".format( - name=self.plotly_name, i=i) - try: - v[i] = validator.validate_coerce(el) - finally: - validator.plotly_name = orig_name + v[i] = self.validate_element_with_indexed_name( + el, validator, [i]) elif not self.free_length and len(v) != len(self.item_validators): + # e.g. 3 element list as layout.xaxis.range self.raise_invalid_val(orig_v) elif self.free_length and len(v) > len(self.item_validators): + # e.g. 4 element list as layout.updatemenu.button.args self.raise_invalid_val(orig_v) else: - # We have an array of the correct length + # We have a 1D array of the correct length for i, (el, validator) in enumerate(zip(v, self.item_validators)): # Validate coerce elements v[i] = validator.validate_coerce(el) diff --git a/_plotly_utils/tests/validators/test_infoarray_validator.py b/_plotly_utils/tests/validators/test_infoarray_validator.py index 1db6ef30a14..84bd284c418 100644 --- a/_plotly_utils/tests/validators/test_infoarray_validator.py +++ b/_plotly_utils/tests/validators/test_infoarray_validator.py @@ -74,6 +74,12 @@ def test_validator_acceptance_any2(val, validator_any2): assert validator_any2.present(coerce_val) == tuple(val) +def test_validator_acceptance_any2_none(validator_any2): + coerce_val = validator_any2.validate_coerce(None) + assert coerce_val is None + assert validator_any2.present(coerce_val) is None + + # ### Rejection by type ### @pytest.mark.parametrize('val', [ 'Not a list', 123, set(), {}