Skip to content

Commit 1a9653c

Browse files
Update KDoc for ggsave()
1 parent 1d4d84e commit 1a9653c

File tree

1 file changed

+8
-5
lines changed
  • plot-api/src/jvmMain/kotlin/org/jetbrains/letsPlot/export

1 file changed

+8
-5
lines changed

plot-api/src/jvmMain/kotlin/org/jetbrains/letsPlot/export/ggsave.kt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,12 @@ private const val DEF_EXPORT_DIR = "lets-plot-images"
3838
* @param h Height of the output image in units.
3939
* @param unit Unit of the output image. One of: `"in"`, `"cm"`, `"mm"`, `"px"`.
4040
* Only applicable when exporting to SVG, PNG, JPG, or TIFF.
41-
* @param dpi Resolution in dots per inch to store in the exported file metadata.
41+
* Default: "in" (inches).
42+
* @param dpi Resolution in dots per inch.
4243
* Only applicable when exporting to the raster formats: PNG, JPG, or TIFF.
43-
* Default: no metadata is stored.
44+
* The default value depends on the [unit]:
45+
* - for `"px"` it is `96` (output image will have the same pixel size as [w] and [h] values)
46+
* - for physical units (`"in"`, `"cm"`, `"mm"`) it is `300`.
4447
* @param path Path to a directory to save image files in.
4548
* Default: `${user.dir}/lets-plot-images`
4649
*
@@ -86,11 +89,11 @@ fun ggsave(
8689
plot: Figure,
8790
filename: String,
8891
scale: Number? = null,
92+
dpi: Number? = null,
93+
path: String? = null,
8994
w: Number? = null,
9095
h: Number? = null,
91-
unit: String? = null,
92-
dpi: Number? = null,
93-
path: String? = null
96+
unit: String? = null
9497
): String {
9598

9699
@Suppress("NAME_SHADOWING")

0 commit comments

Comments
 (0)