@uwdata/mosaic-spec 0.9.0 → 0.11.0

package/LICENSE

@@ -0,0 +1,47 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, UW Interactive Data Lab
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+Portions of this software are derived from Observable Plot, which is released
+under the ISC license.
+
+Copyright 2020-2023 Observable, Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/dist/mosaic-schema.json

@@ -14387,58 +14387,56 @@
               "maxItems": 1,
               "minItems": 1,
               "type": "array"
-            },
-            {
-              "items": [
-                {
-                  "description": "A transform argument.",
-                  "type": [
-                    "string",
-                    "number",
-                    "boolean"
-                  ]
-                },
-                {
-                  "$ref": "#/definitions/BinOptions"
-                }
-              ],
-              "maxItems": 2,
-              "minItems": 2,
-              "type": "array"
             }
           ],
-          "description": "Bin a continuous variable into discrete intervals. This transform accepts a data column to bin over as well as an optional bin options object."
-        }
-      },
-      "required": [
-        "bin"
-      ],
-      "type": "object"
-    },
-    "BinOptions": {
-      "additionalProperties": false,
-      "description": "Bin transform options.",
-      "properties": {
+          "description": "Bin a continuous variable into discrete intervals. The bin argument specifies a data column or expression to bin. Both numerical and temporal (date/time) values are supported."
+        },
+        "interval": {
+          "$ref": "#/definitions/BinInterval",
+          "description": "The interval bin unit to use, typically used to indicate a date/time unit for binning temporal values, such as `hour`, `day`, or `month`. If `date`, the extent of data values is used to automatically select an interval for temporal data. The value `number` enforces normal numerical binning, even over temporal data. If unspecified, defaults to `number` for numerical data and `date` for temporal data."
+        },
         "minstep": {
-          "description": "The minimum allowed bin step size (default `0`). For example, a setting of `1` will prevent step sizes less than 1.",
+          "description": "The minimum allowed bin step size (default `0`) when performing numerical binning. For example, a setting of `1` prevents step sizes less than 1. This option is ignored when **step** is specified.",
           "type": "number"
         },
         "nice": {
           "const": true,
-          "description": "A flag requesting \"nice\" human-friendly step sizes (default `true`).",
+          "description": "A flag (default `true`) requesting \"nice\" human-friendly end points and step sizes when performing numerical binning. When **step** is specified, this option affects the binning end points (e.g., origin) only.",
           "type": "boolean"
         },
         "offset": {
           "description": "Offset for computed bins (default `0`). For example, a value of `1` will result in using the next consecutive bin boundary.",
           "type": "number"
         },
+        "step": {
+          "description": "The step size to use between bins. When binning numerical values (or interval type `number`), this setting specifies the numerical step size. For data/time intervals, this indicates the number of steps of that unit, such as hours, days, or years.",
+          "type": "number"
+        },
         "steps": {
-          "description": "The target number of binning steps to use. To accommodate human-friendly bin boundaries, the actual number of bins may diverge from this exact number.",
+          "description": "The target number of binning steps to use. To accommodate human-friendly (\"nice\") bin boundaries, the actual number of bins may diverge from this exact value. This option is ignored when **step** is specified.",
           "type": "number"
         }
       },
+      "required": [
+        "bin"
+      ],
       "type": "object"
     },
+    "BinInterval": {
+      "description": "Binning interval names.",
+      "enum": [
+        "date",
+        "number",
+        "millisecond",
+        "second",
+        "minute",
+        "hour",
+        "day",
+        "month",
+        "year"
+      ],
+      "type": "string"
+    },
     "BrushStyles": {
       "additionalProperties": false,
       "description": "Styles for rectangular selection brushes.",
@@ -14867,6 +14865,9 @@
         "content": {
           "type": "string"
         },
+        "contentVisibility": {
+          "type": "string"
+        },
         "counterIncrement": {
           "type": "string"
         },
@@ -15653,6 +15654,12 @@
         "textWrap": {
           "type": "string"
         },
+        "textWrapMode": {
+          "type": "string"
+        },
+        "textWrapStyle": {
+          "type": "string"
+        },
         "top": {
           "type": "string"
         },
@@ -15674,6 +15681,9 @@
         "transition": {
           "type": "string"
         },
+        "transitionBehavior": {
+          "type": "string"
+        },
         "transitionDelay": {
           "type": "string"
         },
@@ -15701,6 +15711,9 @@
         "verticalAlign": {
           "type": "string"
         },
+        "viewTransitionName": {
+          "type": "string"
+        },
         "visibility": {
           "type": "string"
         },
@@ -15917,6 +15930,9 @@
         "whiteSpace": {
           "type": "string"
         },
+        "whiteSpaceCollapse": {
+          "type": "string"
+        },
         "widows": {
           "type": "string"
         },
@@ -15946,6 +15962,9 @@
         },
         "zIndex": {
           "type": "string"
+        },
+        "zoom": {
+          "type": "string"
         }
       },
       "type": "object"
@@ -69929,6 +69948,20 @@
           ],
           "description": "A power scale’s exponent (*e.g.*, 0.5 for sqrt); defaults to 1 for a linear scale. For *pow* scales only."
         },
+        "rLabel": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/definitions/ParamRef"
+            }
+          ],
+          "description": "A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value."
+        },
         "rNice": {
           "anyOf": [
             {
@@ -72777,6 +72810,20 @@
           ],
           "description": "A power scale’s exponent (*e.g.*, 0.5 for sqrt); defaults to 1 for a linear scale. For *pow* scales only."
         },
+        "rLabel": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/definitions/ParamRef"
+            }
+          ],
+          "description": "A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value."
+        },
         "rNice": {
           "anyOf": [
             {
@@ -84770,6 +84817,24 @@
           "description": "A flag for cross-filtering, where selections made in a plot filter others but not oneself (default `false`, except for `crossfilter` selections).",
           "type": "boolean"
         },
+        "empty": {
+          "description": "A flag for setting an initial empty selection state. If true, a selection with no clauses corresponds to an empty selection with no records. If false, a selection with no clauses selects all values.",
+          "type": "boolean"
+        },
+        "include": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ParamRef"
+            },
+            {
+              "items": {
+                "$ref": "#/definitions/ParamRef"
+              },
+              "type": "array"
+            }
+          ],
+          "description": "Upstream selections whose clauses should be included as part of this selection. Any clauses or activations published to the upstream selections will be relayed to this selection."
+        },
         "select": {
           "description": "The type of reactive parameter. One of:\n- `\"value\"` (default) for a standard `Param`\n- `\"intersect\"` for a `Selection` that intersects clauses (logical \"and\")\n- `\"union\"` for a `Selection` that unions clauses (logical \"or\")\n- `\"single\"` for a `Selection` that retains a single clause only\n- `\"crossfilter\"` for a cross-filtered intersection `Selection`",
           "enum": [
@@ -85456,6 +85521,10 @@
               "description": "An object of per-column alignment values. Column names should be object keys, which map to alignment values. Valid alignment values are: `\"left\"`, `\"right\"`, `\"center\"`, and `\"justify\"`. By default, numbers are right-aligned and other values are left-aligned.",
               "type": "object"
             },
+            "as": {
+              "$ref": "#/definitions/ParamRef",
+              "description": "The output selection. A selection clause is added for each currently selected table row."
+            },
             "columns": {
               "description": "A list of column names to include in the table grid. If unspecified, all table columns are included.",
               "items": {
@@ -87343,6 +87412,20 @@
               ],
               "description": "A power scale’s exponent (*e.g.*, 0.5 for sqrt); defaults to 1 for a linear scale. For *pow* scales only."
             },
+            "rLabel": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                },
+                {
+                  "$ref": "#/definitions/ParamRef"
+                }
+              ],
+              "description": "A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value."
+            },
             "rNice": {
               "anyOf": [
                 {
@@ -179672,6 +179755,10 @@
           "description": "An object of per-column alignment values. Column names should be object keys, which map to alignment values. Valid alignment values are: `\"left\"`, `\"right\"`, `\"center\"`, and `\"justify\"`. By default, numbers are right-aligned and other values are left-aligned.",
           "type": "object"
         },
+        "as": {
+          "$ref": "#/definitions/ParamRef",
+          "description": "The output selection. A selection clause is added for each currently selected table row."
+        },
         "columns": {
           "description": "A list of column names to include in the table grid. If unspecified, all table columns are included.",
           "items": {