Add inheritAes parameter in layers (LP #1172)

Author: alshan

demo/jvm-batik/src/main/kotlin/frontendContextDemo/scripts/InheritAes.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2019. JetBrains s.r.o.
+ * Use of this source code is governed by the MIT license that can be found in the LICENSE file.
+ */
+
+package frontendContextDemo.scripts
+
+import frontendContextDemo.ScriptInBatikContext
+import org.jetbrains.letsPlot.geom.geomPoint
+import org.jetbrains.letsPlot.ggplot
+
+object InheritAes {
+    @JvmStatic
+    fun main(args: Array<String>) {
+        ScriptInBatikContext.eval("Squares do not inherit AES") {
+            val data = mapOf<String, Any>(
+                "weight" to listOf(68, 84, 73),
+                "height" to listOf(175, 169, 180),
+                "shoe" to listOf(42, 40, 45)
+            )
+
+
+            val p = ggplot(data) {
+                x = "weight"
+                y = "height"
+                size = "shoe"
+            } +
+                    geomPoint(color = "red") +
+                    geomPoint(shape = 0, inheritAes = false) {
+                        x = "weight"
+                        y = "height"
+                        color = "shoe"
+                    }
+
+            p.show()
+        }
+    }
+}

future_changes.md

@@ -3,7 +3,7 @@
 ### Added
 
 ToDo: `geomBlank()` [[#831](https://github.com/JetBrains/lets-plot/issues/831)].
-ToDo: `inheritAes` parameter in layers [[#1172](https://github.com/JetBrains/lets-plot/issues/1172)].
+`inheritAes` parameter in layers [[#1172](https://github.com/JetBrains/lets-plot/issues/1172)].
 
 ### Changed
 

gradle.properties

@@ -24,7 +24,7 @@ nexusStaging.version=0.30.0
 nexusPublish.version=1.3.0
 
 # Also update JS version in <home>/demo/js-frontend-app/src/main/resources/index.html
-letsPlot.version=4.4.1
+letsPlot.version=4.4.2-SNAPSHOT
 
 # The latest GeoTools 30-RC do not compile due to
 # "renaming of all "org.opengis" packages into "org.geotools.api" ones"

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_abline.kt

@@ -34,6 +34,8 @@ import org.jetbrains.letsPlot.pos.positionIdentity
  *  [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
  * @param showLegend default = true.
  *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
  * @param manualKey String or result of the call to the `layerKey()` function.
  *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
  * @param sampling Result of the call to the `samplingXxx()` function.
@@ -63,6 +65,7 @@ class geomABLine(
     stat: StatOptions = Stat.identity,
     position: PosOptions = positionIdentity,
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     sampling: SamplingOptions? = null,
     orientation: String? = null,
@@ -83,6 +86,7 @@ class geomABLine(
         stat = stat,
         position = position,
         showLegend = showLegend,
+        inheritAes = inheritAes,
         manualKey = manualKey,
         sampling = sampling,
         orientation = orientation

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_area.kt

@@ -38,6 +38,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  *  `positionStack()`, `positionDodge()`, etc. see [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
  * @param showLegend default = true.
  *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
  * @param manualKey String or result of the call to the `layerKey()` function.
  *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
  * @param sampling Result of the call to the `samplingXxx()` function.
@@ -74,6 +76,7 @@ class geomArea(
     stat: StatOptions = identity,
     position: PosOptions = positionStack(),
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     sampling: SamplingOptions? = null,
     tooltips: TooltipOptions? = null,
@@ -99,6 +102,7 @@ class geomArea(
         stat = stat,
         position = position,
         showLegend = showLegend,
+        inheritAes = inheritAes,
         manualKey = manualKey,
         sampling = sampling,
         tooltips = tooltips

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_area_ridges.kt

@@ -45,6 +45,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  *  [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
  * @param showLegend default = true.
  *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
  * @param manualKey String or result of the call to the `layerKey()` function.
  *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
  * @param sampling Result of the call to the `samplingXxx()` function.
@@ -103,6 +105,7 @@ class geomAreaRidges(
     stat: StatOptions = Stat.densityRidges(),
     position: PosOptions = positionIdentity,
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     sampling: SamplingOptions? = null,
     tooltips: TooltipOptions? = null,
@@ -143,6 +146,7 @@ class geomAreaRidges(
         stat = stat,
         position = position,
         showLegend = showLegend,
+        inheritAes = inheritAes,
         manualKey = manualKey,
         sampling = sampling,
         tooltips = tooltips

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_band.kt

@@ -25,6 +25,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  *  see [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
  * @param showLegend default = true.
  *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
  * @param manualKey String or result of the call to the `layerKey()` function.
  *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
  * @param sampling Result of the call to the `samplingXxx()` function.
@@ -60,6 +62,7 @@ class geomBand(
     stat: StatOptions = Stat.identity,
     position: PosOptions = positionIdentity,
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     sampling: SamplingOptions? = null,
     tooltips: TooltipOptions? = null,
@@ -85,6 +88,7 @@ class geomBand(
         stat = stat,
         position = position,
         showLegend = showLegend,
+        inheritAes = inheritAes,
         manualKey = manualKey,
         sampling = sampling,
         tooltips = tooltips

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_bar.kt

@@ -50,6 +50,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  *  `positionStack()`, `positionDodge()`, etc. see [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
  * @param showLegend default = true.
  *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
  * @param manualKey String or result of the call to the `layerKey()` function.
  *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
  * @param sampling Result of the call to the `samplingXxx()` function.
@@ -86,6 +88,7 @@ class geomBar(
     stat: StatOptions = Stat.count(),
     position: PosOptions = positionStack(),
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     sampling: SamplingOptions? = null,
     tooltips: TooltipOptions? = null,
@@ -114,6 +117,7 @@ class geomBar(
         stat = stat,
         position = position,
         showLegend = showLegend,
+        inheritAes = inheritAes,
         manualKey = manualKey,
         sampling = sampling,
         tooltips = tooltips,

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_bin2d.kt

@@ -44,6 +44,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  *  [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
  * @param showLegend default = true.
  *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
  * @param manualKey String or result of the call to the `layerKey()` function.
  *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
  * @param sampling Result of the call to the `samplingXxx()` function.
@@ -83,6 +85,7 @@ class geomBin2D(
     stat: StatOptions = Stat.bin2D(),
     position: PosOptions = positionIdentity,
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     sampling: SamplingOptions? = null,
     tooltips: TooltipOptions? = null,
@@ -114,6 +117,7 @@ class geomBin2D(
         stat = stat,
         position = position,
         showLegend = showLegend,
+        inheritAes = inheritAes,
         manualKey = manualKey,
         sampling = sampling,
         tooltips = tooltips

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_boxplot.kt

@@ -49,6 +49,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  *  `positionStack()`, `positionDodge()`, etc. see [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
  * @param showLegend default = true.
  *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
  * @param manualKey String or result of the call to the `layerKey()` function.
  *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
  * @param tooltips Result of the call to the `layerTooltips()` function.
@@ -103,6 +105,7 @@ fun geomBoxplot(
     stat: StatOptions = Stat.boxplot(),
     position: PosOptions = positionDodge(),
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     tooltips: TooltipOptions? = null,
     orientation: String? = null,
@@ -146,6 +149,7 @@ fun geomBoxplot(
         stat,
         position,
         showLegend,
+        inheritAes,
         manualKey,
         tooltips,
         orientation,
@@ -178,6 +182,7 @@ fun geomBoxplot(
             stat = Stat.boxplotOutlier(),
             position = position,
             showLegend = false,
+            inheritAes = inheritAes,
             manualKey = null,
             sampling = null,
             orientation = orientation,
@@ -202,6 +207,7 @@ private class geomBoxplotInternal(
     stat: StatOptions = Stat.boxplot(),
     position: PosOptions = positionDodge(),
     showLegend: Boolean = true,
+    inheritAes: Boolean? = null,
     manualKey: Any? = null,
     tooltips: TooltipOptions? = null,
     orientation: String? = null,
@@ -242,6 +248,7 @@ private class geomBoxplotInternal(
         stat = stat,
         position = position,
         showLegend = showLegend,
+        inheritAes = inheritAes,
         manualKey = manualKey,
         sampling = null,
         tooltips = tooltips,