lets-plot 4.4.1__cp311-cp311-win_amd64.whl → 4.5.0__cp311-cp311-win_amd64.whl

lets_plot/__init__.py

@@ -108,7 +108,7 @@ class LetsPlot:
     def set(cls, settings: Dict):
         """
         Set up library options.
-        For more info see https://lets-plot.org/python/pages/basemap_tiles.html#configuring-globally.
+        For more info see `Configuring Globally <https://lets-plot.org/python/pages/basemap_tiles.html#configuring-globally>`__.
 
         Parameters
         ----------

lets_plot/_version.py

@@ -3,4 +3,4 @@
 # Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 #
 # see: https://www.python.org/dev/peps/pep-0440/#developmental-releases
-__version__ = '4.4.1'
+__version__ = '4.5.0'

lets_plot/bistro/corr.py

@@ -68,6 +68,11 @@ class corr_plot:
     """
     This class is intended to build correlation matrix plot.
 
+    Notes
+    -----
+    To hide axis tooltips, set 'blank' or the result of `element_blank()`
+    to the `axis_tooltip`, `axis_tooltip_x` or `axis_tooltip_y` parameter of the `theme()`.
+
     Examples
     --------
     .. jupyter-execute::
@@ -205,7 +210,7 @@ class corr_plot:
             If False - the text size is constant. Default - contextual.
         color : str
             Set text color.
-            For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+            For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
             Default - contextual.
 
         Returns

lets_plot/bistro/joint.py

@@ -64,7 +64,7 @@ def joint_plot(data, x, y, *,
         Applicable simultaneously for 'tile' geom and 'histogram' marginal.
     color : str
         Color of the geometry.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+        For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
     size : float
         Size of the geometry.
     alpha : float
@@ -77,7 +77,7 @@ def joint_plot(data, x, y, *,
         True - show the line of linear regression.
     se : bool, default=True
         Display confidence interval around regression line.
-    marginal : str, default='dens:r'
+    marginal : str
         Description of marginal layers packed to string value.
         Different marginals are separated by the ',' char.
         Parameters of a marginal are separated by the ':' char.
@@ -97,6 +97,11 @@ def joint_plot(data, x, y, *,
     `PlotSpec`
         Plot object specification.
 
+    Notes
+    -----
+    To hide axis tooltips, set 'blank' or the result of `element_blank()`
+    to the `axis_tooltip`, `axis_tooltip_x` or `axis_tooltip_y` parameter of the `theme()`.
+
     Examples
     --------
     .. jupyter-execute::

lets_plot/bistro/qq.py

@@ -10,6 +10,7 @@ def qq_plot(data=None, sample=None, *, x=None, y=None,
             distribution=None, dparams=None, quantiles=None,
             group=None,
             show_legend=None,
+            marginal=None,
             color=None, fill=None, alpha=None, size=None, shape=None,
             line_color=None, line_size=None, linetype=None) -> PlotSpec:
     """
@@ -49,29 +50,44 @@ def qq_plot(data=None, sample=None, *, x=None, y=None,
         If it is specified and color-parameters isn't then different groups will has different colors.
     show_legend : bool, default=True
         False - do not show legend.
+    marginal : str, default='dens:tr'
+        Description of marginal layers packed to string value.
+        Different marginals are separated by the ',' char.
+        Parameters of a marginal are separated by the ':' char.
+        First parameter of a marginal is a geometry name.
+        Possible values: 'dens'/'density', 'hist'/'histogram', 'box'/'boxplot'.
+        Second parameter is a string specifying which sides of the plot the marginal layer will appear on.
+        Possible values: 't' (top), 'b' (bottom), 'l' (left), 'r' (right).
+        Third parameter (optional) is size of marginal.
+        To suppress marginals use `marginal='none'`.
+        Examples:
+        "hist:tr:0.3",
+        "dens:tr,hist:bl",
+        "box : tr : .05, dens : bl".
     color : str
         Color of a points.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+        For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
     fill : str
         Color to paint shape's inner points. Is applied only to the points of shapes having inner points.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+        For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
     alpha : float, default=0.5
         Transparency level of points. Accept values between 0 and 1.
     size : float, default=3.0
         Size of the points.
     shape : int
         Shape of the points, an integer from 0 to 25.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#point-shapes.
+        For more info see `Point Shapes <https://lets-plot.org/python/pages/aesthetics.html#point-shapes>`__.
     line_color : str, default='#FF0000'
         Color of the fitting line.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+        For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
     line_size : float, default=0.75
         Width of the fitting line.
-    linetype : int or str
+    linetype : int or str or list
         Type of the fitting line.
-        Codes and names: 0 = 'blank', 1 = 'solid', 2 = 'dashed',
-        3 = 'dotted', 4 = 'dotdash', 5 = 'longdash', 6 = 'twodash'.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#line-types.
+        Accept codes or names (0 = 'blank', 1 = 'solid', 2 = 'dashed', 3 = 'dotted', 4 = 'dotdash', 5 = 'longdash', 6 = 'twodash'),
+        a hex string (up to 8 digits for dash-gap lengths),
+        or a list pattern [offset, [dash, gap, ...]] / [dash, gap, ...].
+        For more info see `Line Types <https://lets-plot.org/python/pages/aesthetics.html#line-types>`__.
 
     Returns
     -------
@@ -86,6 +102,11 @@ def qq_plot(data=None, sample=None, *, x=None, y=None,
     If the two distributions being compared are similar, the points in the Q-Q plot
     will approximately lie on the straight line.
 
+    ----
+
+    To hide axis tooltips, set 'blank' or the result of `element_blank()`
+    to the `axis_tooltip`, `axis_tooltip_x` or `axis_tooltip_y` parameter of the `theme()`.
+
     Examples
     --------
     .. jupyter-execute::
@@ -174,6 +195,7 @@ def qq_plot(data=None, sample=None, *, x=None, y=None,
         'quantiles': quantiles,
         'group': group,
         'show_legend': show_legend,
+        'marginal': marginal,
         'color': color,
         'fill': fill,
         'alpha': alpha,

lets_plot/bistro/residual.py

@@ -178,7 +178,7 @@ def residual_plot(data=None, x=None, y=None, *,
         Applicable simultaneously for 'tile' geom and 'histogram' marginal.
     color : str
         Color of the geometry.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+        For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
     size : float
         Size of the geometry.
     alpha : float
@@ -214,6 +214,11 @@ def residual_plot(data=None, x=None, y=None, *,
     When using 'lm' and 'loess' methods,
     this function requires the `statsmodels` and `scipy` libraries to be installed.
 
+    ----
+
+    To hide axis tooltips, set 'blank' or the result of `element_blank()`
+    to the `axis_tooltip`, `axis_tooltip_x` or `axis_tooltip_y` parameter of the `theme()`.
+
     Examples
     --------
     .. jupyter-execute::

lets_plot/bistro/waterfall.py

@@ -12,6 +12,7 @@ def waterfall_plot(data, x, y, *,
                    width=None,
                    show_legend=None, relative_tooltips=None, absolute_tooltips=None,
                    sorted_value=None, threshold=None, max_values=None,
+                   base=None,
                    calc_total=None, total_title=None,
                    hline=None, hline_ontop=None,
                    connector=None,
@@ -39,21 +40,22 @@ def waterfall_plot(data, x, y, *,
         Grouping variable. Each group calculates its own statistics.
     color : str
         Color of the box boundary lines.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+        For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
         Use 'flow_type' to color lines by the direction of the flow.
     fill : str
         Fill color of the boxes.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#color-and-fill.
+        For more info see `Color and Fill <https://lets-plot.org/python/pages/aesthetics.html#color-and-fill>`__.
         Use 'flow_type' to color boxes by the direction of the flow.
     size : float, default=0.0
         Line width of the box boundary lines.
     alpha : float
         Transparency level of the boxes. Accept values between 0 and 1.
-    linetype : int or str
+    linetype : int or str or list
         Type of the box boundary lines.
-        Codes and names: 0 = 'blank', 1 = 'solid', 2 = 'dashed',
-        3 = 'dotted', 4 = 'dotdash', 5 = 'longdash', 6 = 'twodash'.
-        For more info see https://lets-plot.org/python/pages/aesthetics.html#line-types.
+        Accept codes or names (0 = 'blank', 1 = 'solid', 2 = 'dashed', 3 = 'dotted', 4 = 'dotdash', 5 = 'longdash', 6 = 'twodash'),
+        a hex string (up to 8 digits for dash-gap lengths),
+        or a list pattern [offset, [dash, gap, ...]] / [dash, gap, ...].
+        For more info see `Line Types <https://lets-plot.org/python/pages/aesthetics.html#line-types>`__.
     width : float, default=0.9
         Width of the boxes. Typically range between 0 and 1.
         Values that are greater than 1 lead to overlapping of the boxes.
@@ -77,6 +79,8 @@ def waterfall_plot(data, x, y, *,
         Groups all categories under a certain threshold value into "Other" category.
     max_values : int
         Groups all categories with the smallest changes, except the first `max_values`, into "Other" category.
+    base : float, default=0.0
+        Values with measure 'absolute' or 'total' are relative to this value.
     calc_total : bool, default=True
         Setting the `calc_total` to True will put the final cumulative sum into a new separate box.
         Taken into account only if the 'measure' column isn't provided.
@@ -106,7 +110,7 @@ def waterfall_plot(data, x, y, *,
         - 'Num {}' -> 'Num 12.456789'
         - 'TTL: {.2f}$' -> 'TTL: 12.45$'
 
-        For more info see https://lets-plot.org/python/pages/formats.html.
+        For more info see `Formatting <https://lets-plot.org/python/pages/formats.html>`__.
 
     Returns
     -------
@@ -235,6 +239,7 @@ def waterfall_plot(data, x, y, *,
         'sorted_value': sorted_value,
         'threshold': threshold,
         'max_values': max_values,
+        'base': base,
         'calc_total': calc_total,
         'total_title': total_title,
         'hline': hline,

lets_plot/export/ggsave_.py

@@ -34,7 +34,7 @@ def ggsave(plot: Union[PlotSpec, SupPlotsSpec, GGBunch], filename: str, *, path:
         to one of the supported formats: SVG, HTML (or HTM), PNG (requires CairoSVG library), PDF.
     path : str
         Path to a directory to save image files in.
-        By default it is ${user.dir}/lets-plot-images.
+        By default, it is ${user.dir}/lets-plot-images.
     iframe : bool, default=True
         Whether to wrap HTML page into a iFrame.
         Only applicable when exporting to HTML.
@@ -60,6 +60,26 @@ def ggsave(plot: Union[PlotSpec, SupPlotsSpec, GGBunch], filename: str, *, path:
     str
         Absolute pathname of created file.
 
+    Notes
+    -----
+    Output format is inferred from the filename extension.
+
+    For PNG and PDF formats:
+
+    1. If `w`, `h`, `unit`, and `dpi` are all specified:
+
+       - `scale` is ignored.
+       - The plot's pixel size (default or set by `ggsize()`) is converted to the specified units using the given dpi.
+       - If the aspect ratio of `w` and `h` differs from the plot's pixel aspect ratio:
+
+         * The plot maintains its original (pixel) aspect ratio.
+         * It's fitted within the specified `w` x `h` area.
+         * Any extra space is left empty.
+
+    2. If `w`, `h` are not specified:
+
+       - The `scale` parameter is used to determine the output size.
+
     Examples
     --------
     .. code-block::