lets-plot 4.7.2rc1__cp39-cp39-macosx_10_15_x86_64.whl → 4.8.0rc1__cp39-cp39-macosx_10_15_x86_64.whl

lets_plot/__init__.py

@@ -49,7 +49,7 @@ class LetsPlot:
         Parameters
         ----------
         isolated_frame : bool
-            True - generate HTLM which can be used in iframe or in a standalone HTML document.
+            True - generate HTML which can be used in iframe or in a standalone HTML document.
             False - pre-load Lets-Plot JS library. Notebook cell output will only consist
             of HTML for the plot rendering. Default: None - auto-detect.
         offline : bool

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.7.2rc1'
+__version__ = '4.8.0rc1'

lets_plot/bistro/_plot2d_common.py

@@ -55,6 +55,12 @@ def _get_geom2d_layer(geom_kind, binwidth2d, bins2d, color, color_by, size, alph
             color=color, size=size, alpha=alpha,
             show_legend=show_legend
         )
+    if geom_kind == 'pointdensity':
+        return geom_pointdensity(
+            aes(color=('..density..' if color_by is None else color_by)),
+            color=color, size=size, alpha=alpha,
+            show_legend=show_legend
+        )
     if geom_kind == 'none':
         return None
     raise Exception("Unknown geom '{0}'".format(geom_kind))

lets_plot/bistro/joint.py

@@ -2,11 +2,11 @@
 #  Copyright (c) 2023. JetBrains s.r.o.
 #  Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 #
-from ..plot.plot import ggplot
+from ._plot2d_common import _get_bin_params_2d, _get_geom2d_layer, _get_marginal_layers
 from ..plot.core import DummySpec, aes
 from ..plot.geom import geom_smooth
 from ..plot.label import xlab, ylab
-from ._plot2d_common import _get_bin_params_2d, _get_geom2d_layer, _get_marginal_layers
+from ..plot.plot import ggplot
 
 __all__ = ['joint_plot']
 
@@ -27,7 +27,7 @@ def _get_marginal_def(geom_kind, color_by=None):
 def _is_reg_line_needed(reg_line, geom_kind):
     if reg_line is not None:
         return reg_line
-    if geom_kind == 'point':
+    if geom_kind in ['point', 'pointdensity']:
         return True
     else:
         return False
@@ -51,7 +51,7 @@ def joint_plot(data, x, y, *,
         The data to be displayed.
     x, y : str
         Names of a variables.
-    geom : {'point', 'tile', 'hex', 'density2d', 'density2df'}, default='point'
+    geom : {'point', 'tile', 'hex', 'density2d', 'density2df', 'pointdensity'}, default='point'
         The geometric object to use to display the data.
     bins : int or list of int
         Number of bins in both directions, vertical and horizontal. Overridden by ``binwidth``.

lets_plot/bistro/residual.py

@@ -165,7 +165,7 @@ def residual_plot(data=None, x=None, y=None, *,
         Random seed for 'loess' sampling.
     max_n : int
         Maximum number of data-points for 'loess' method. If this quantity exceeded random sampling is applied to data.
-    geom : {'point', 'tile', 'hex', 'density2d', 'density2df', 'none'}, default='point'
+    geom : {'point', 'tile', 'hex', 'density2d', 'density2df', 'pointdensity', 'none'}, default='point'
         The geometric object to use to display the data. No object will be used if ``geom='none'``.
     bins : int or list of int
         Number of bins in both directions, vertical and horizontal. Overridden by ``binwidth``.

lets_plot/export/ggsave_.py

@@ -22,7 +22,7 @@ def ggsave(plot: Union[PlotSpec, SupPlotsSpec, GGBunch], filename: str, *, path:
     Export plot to a file.
     Supported formats: PNG, SVG, PDF, HTML.
 
-    The exported file is created in directory ${user.dir}/lets-plot-images
+    The exported file is created in the directory ${user.dir}/lets-plot-images
     if not specified otherwise (see the ``path`` parameter).
 
     Parameters
@@ -36,7 +36,7 @@ def ggsave(plot: Union[PlotSpec, SupPlotsSpec, GGBunch], filename: str, *, path:
         Path to a directory to save image files in.
         By default, it is ${user.dir}/lets-plot-images.
     iframe : bool, default=True
-        Whether to wrap HTML page into a iFrame.
+        Whether to wrap the HTML page into an iFrame.
         Only applicable when exporting to HTML.
         Some browsers may not display some UTF-8 characters correctly when setting iframe=True
     scale : float, default=2.0
@@ -44,19 +44,19 @@ def ggsave(plot: Union[PlotSpec, SupPlotsSpec, GGBunch], filename: str, *, path:
         Only applicable when exporting to PNG or PDF.
     w : float, default=None
         Width of the output image in units.
-        Only applicable when exporting to SVG, PNG or PDF.
+        Only applicable when exporting to SVG, PNG, or PDF.
     h : float, default=None
         Height of the output image in units.
-        Only applicable when exporting to SVG, PNG or PDF.
+        Only applicable when exporting to SVG, PNG, or PDF.
     unit : {'in', 'cm', 'mm', 'px'}, default='in'
         Unit of the output image. One of: 'in', 'cm', 'mm' or 'px'.
-        Only applicable when exporting to SVG, PNG or PDF.
+        Only applicable when exporting to SVG, PNG, or PDF.
     dpi : int, default=300
         Resolution in dots per inch.
         Only applicable when exporting to PNG or PDF.
         The default value depends on the unit:
 
-        - for 'px' it is 96 (output image will have the same pixel size as ``w`` and ``h`` values)
+        - for 'px' it is 96 (output image will have the same pixel size as ``w``, and ``h`` values)
         - for physical units ('in', 'cm', 'mm') it is 300.
 
     Returns
@@ -66,14 +66,21 @@ def ggsave(plot: Union[PlotSpec, SupPlotsSpec, GGBunch], filename: str, *, path:
 
     Notes
     -----
-    Output format is inferred from the filename extension.
+    Large plot dimensions without units require explicit unit specification.
+    When ``w`` or ``h`` value exceeds 20 without specifying units (e.g., ``ggsave(p, 300, 400)``),
+    we ask to specify units explicitly:
+    ``ggsave(p, 300, 400, unit='px')`` or ``ggsave(p, 3, 4, unit='in')``.
 
-    For PNG and PDF formats:
+    ----
+
+    The output format is inferred from the filename extension.
+
+    For PNG, and PDF formats:
 
     - If ``w``, ``h``, ``unit``, and ``dpi`` are all specified:
 
       - The plot's pixel size (default or set by `ggsize() <https://lets-plot.org/python/pages/api/lets_plot.ggsize.html>`__) is ignored.
-      - The output size is calculated using the specified ``w``, ``h``, ``unit``, and ``dpi``.
+      - The output size is calculated using the specified ``w``, ``h``, ``unit`` and ``dpi``.
 
         - The plot is resized to fit the specified ``w`` x ``h`` area, which may affect the layout, tick labels, and other elements.
 
@@ -94,33 +101,43 @@ def ggsave(plot: Union[PlotSpec, SupPlotsSpec, GGBunch], filename: str, *, path:
 
     For SVG format:
 
-    - If ``w``, ``h`` and ``unit`` are specified:
+    - If ``w``, ``h``, and ``unit`` are specified:
 
       - The plot's pixel size (default or set by `ggsize() <https://lets-plot.org/python/pages/api/lets_plot.ggsize.html>`__) is ignored.
       - The output size is calculated using the specified ``w``, ``h``, and ``unit``.
 
+    ----
+
+    Plots with ``geom_livemap()`` can be saved to HTML only.
+
 
     Examples
     --------
-    .. code-block::
+    .. jupyter-execute::
         :linenos:
-        :emphasize-lines: 4
+        :emphasize-lines: 6
 
+        from IPython.display import Image
         from lets_plot import *
         LetsPlot.setup_html()
-        plot = ggplot() + geom_point(x=0, y=0)
-        ggsave(plot, 'plot.html', path='.', iframe=False)
+        filename = 'plot.png'
+        plot = ggplot() + geom_point(x=0, y=0) + ggtitle(filename)
+        fullpath = ggsave(plot, filename, w=4, h=3)
+        Image(filename=fullpath, width=600, height=450)
 
     |
 
-    .. code-block::
+    .. jupyter-execute::
         :linenos:
-        :emphasize-lines: 4
+        :emphasize-lines: 6
 
+        from IPython.display import HTML
         from lets_plot import *
         LetsPlot.setup_html()
-        plot = ggplot() + geom_point(x=0, y=0)
-        ggsave(plot, 'plot.png', w=4, h=3)
+        filename = 'plot.html'
+        plot = ggplot() + geom_point(x=0, y=0) + ggtitle(filename)
+        fullpath = ggsave(plot, filename, iframe=False)
+        HTML(filename=fullpath)
 
     """