@ggts-sh/spec 0.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +75 -0
- package/dist/artifact.d.ts +11 -0
- package/dist/artifact.d.ts.map +1 -0
- package/dist/artifact.js +71 -0
- package/dist/artifact.js.map +1 -0
- package/dist/builder-core.d.ts +100 -0
- package/dist/builder-core.d.ts.map +1 -0
- package/dist/builder-core.js +176 -0
- package/dist/builder-core.js.map +1 -0
- package/dist/builder-data.d.ts +36 -0
- package/dist/builder-data.d.ts.map +1 -0
- package/dist/builder-data.js +123 -0
- package/dist/builder-data.js.map +1 -0
- package/dist/builder-geoms.d.ts +128 -0
- package/dist/builder-geoms.d.ts.map +1 -0
- package/dist/builder-geoms.js +221 -0
- package/dist/builder-geoms.js.map +1 -0
- package/dist/builder-options.d.ts +323 -0
- package/dist/builder-options.d.ts.map +1 -0
- package/dist/builder-options.js +2 -0
- package/dist/builder-options.js.map +1 -0
- package/dist/builder-scales.d.ts +160 -0
- package/dist/builder-scales.d.ts.map +1 -0
- package/dist/builder-scales.js +322 -0
- package/dist/builder-scales.js.map +1 -0
- package/dist/builder.d.ts +242 -0
- package/dist/builder.d.ts.map +1 -0
- package/dist/builder.js +42 -0
- package/dist/builder.js.map +1 -0
- package/dist/capabilities-data.d.ts +72 -0
- package/dist/capabilities-data.d.ts.map +1 -0
- package/dist/capabilities-data.js +337 -0
- package/dist/capabilities-data.js.map +1 -0
- package/dist/capabilities-helpers.d.ts +31 -0
- package/dist/capabilities-helpers.d.ts.map +1 -0
- package/dist/capabilities-helpers.js +41 -0
- package/dist/capabilities-helpers.js.map +1 -0
- package/dist/capabilities.d.ts +22 -0
- package/dist/capabilities.d.ts.map +1 -0
- package/dist/capabilities.js +154 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/coord-helpers.d.ts +102 -0
- package/dist/coord-helpers.d.ts.map +1 -0
- package/dist/coord-helpers.js +90 -0
- package/dist/coord-helpers.js.map +1 -0
- package/dist/coord-reference-build.d.ts +50 -0
- package/dist/coord-reference-build.d.ts.map +1 -0
- package/dist/coord-reference-build.js +211 -0
- package/dist/coord-reference-build.js.map +1 -0
- package/dist/coord-reference.d.ts +52 -0
- package/dist/coord-reference.d.ts.map +1 -0
- package/dist/coord-reference.js +27 -0
- package/dist/coord-reference.js.map +1 -0
- package/dist/error-catalog.d.ts +258 -0
- package/dist/error-catalog.d.ts.map +1 -0
- package/dist/error-catalog.js +235 -0
- package/dist/error-catalog.js.map +1 -0
- package/dist/error-prose-shared.d.ts +100 -0
- package/dist/error-prose-shared.d.ts.map +1 -0
- package/dist/error-prose-shared.js +95 -0
- package/dist/error-prose-shared.js.map +1 -0
- package/dist/errors.d.ts +39 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +52 -0
- package/dist/errors.js.map +1 -0
- package/dist/generated/coord-reference-data.d.ts +189 -0
- package/dist/generated/coord-reference-data.d.ts.map +1 -0
- package/dist/generated/coord-reference-data.js +212 -0
- package/dist/generated/coord-reference-data.js.map +1 -0
- package/dist/generated/geom-param-keys.d.ts +58 -0
- package/dist/generated/geom-param-keys.d.ts.map +1 -0
- package/dist/generated/geom-param-keys.js +223 -0
- package/dist/generated/geom-param-keys.js.map +1 -0
- package/dist/generated/geom-reference-data.d.ts +2377 -0
- package/dist/generated/geom-reference-data.d.ts.map +1 -0
- package/dist/generated/geom-reference-data.js +2790 -0
- package/dist/generated/geom-reference-data.js.map +1 -0
- package/dist/generated/guide-reference-data.d.ts +219 -0
- package/dist/generated/guide-reference-data.d.ts.map +1 -0
- package/dist/generated/guide-reference-data.js +253 -0
- package/dist/generated/guide-reference-data.js.map +1 -0
- package/dist/generated/plot-spec-validator.d.ts +2 -0
- package/dist/generated/plot-spec-validator.d.ts.map +1 -0
- package/dist/generated/plot-spec-validator.js +6274 -0
- package/dist/generated/plot-spec-validator.js.map +1 -0
- package/dist/generated/position-reference-data.d.ts +82 -0
- package/dist/generated/position-reference-data.d.ts.map +1 -0
- package/dist/generated/position-reference-data.js +181 -0
- package/dist/generated/position-reference-data.js.map +1 -0
- package/dist/generated/scale-reference-data.d.ts +8366 -0
- package/dist/generated/scale-reference-data.d.ts.map +1 -0
- package/dist/generated/scale-reference-data.js +9821 -0
- package/dist/generated/scale-reference-data.js.map +1 -0
- package/dist/generated/stat-reference-data.d.ts +241 -0
- package/dist/generated/stat-reference-data.d.ts.map +1 -0
- package/dist/generated/stat-reference-data.js +311 -0
- package/dist/generated/stat-reference-data.js.map +1 -0
- package/dist/geom-params-build.d.ts +3 -0
- package/dist/geom-params-build.d.ts.map +1 -0
- package/dist/geom-params-build.js +80 -0
- package/dist/geom-params-build.js.map +1 -0
- package/dist/geom-params.d.ts +13 -0
- package/dist/geom-params.d.ts.map +1 -0
- package/dist/geom-params.js +7 -0
- package/dist/geom-params.js.map +1 -0
- package/dist/geom-reference-build.d.ts +29 -0
- package/dist/geom-reference-build.d.ts.map +1 -0
- package/dist/geom-reference-build.js +221 -0
- package/dist/geom-reference-build.js.map +1 -0
- package/dist/geom-reference.d.ts +52 -0
- package/dist/geom-reference.d.ts.map +1 -0
- package/dist/geom-reference.js +72 -0
- package/dist/geom-reference.js.map +1 -0
- package/dist/guide-helpers.d.ts +20 -0
- package/dist/guide-helpers.d.ts.map +1 -0
- package/dist/guide-helpers.js +25 -0
- package/dist/guide-helpers.js.map +1 -0
- package/dist/guide-reference-build.d.ts +42 -0
- package/dist/guide-reference-build.d.ts.map +1 -0
- package/dist/guide-reference-build.js +180 -0
- package/dist/guide-reference-build.js.map +1 -0
- package/dist/guide-reference.d.ts +48 -0
- package/dist/guide-reference.d.ts.map +1 -0
- package/dist/guide-reference.js +32 -0
- package/dist/guide-reference.js.map +1 -0
- package/dist/hue-grey-palettes.d.ts +15 -0
- package/dist/hue-grey-palettes.d.ts.map +1 -0
- package/dist/hue-grey-palettes.js +77 -0
- package/dist/hue-grey-palettes.js.map +1 -0
- package/dist/index.d.ts +364 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +225 -0
- package/dist/index.js.map +1 -0
- package/dist/lint-catalog.d.ts +47 -0
- package/dist/lint-catalog.d.ts.map +1 -0
- package/dist/lint-catalog.js +39 -0
- package/dist/lint-catalog.js.map +1 -0
- package/dist/lint-layer-rules.d.ts +18 -0
- package/dist/lint-layer-rules.d.ts.map +1 -0
- package/dist/lint-layer-rules.js +145 -0
- package/dist/lint-layer-rules.js.map +1 -0
- package/dist/lint-scale-rules.d.ts +8 -0
- package/dist/lint-scale-rules.d.ts.map +1 -0
- package/dist/lint-scale-rules.js +254 -0
- package/dist/lint-scale-rules.js.map +1 -0
- package/dist/lint.d.ts +62 -0
- package/dist/lint.d.ts.map +1 -0
- package/dist/lint.js +57 -0
- package/dist/lint.js.map +1 -0
- package/dist/normalize-coord.d.ts +8 -0
- package/dist/normalize-coord.d.ts.map +1 -0
- package/dist/normalize-coord.js +123 -0
- package/dist/normalize-coord.js.map +1 -0
- package/dist/normalize-input-layers-marks.d.ts +208 -0
- package/dist/normalize-input-layers-marks.d.ts.map +1 -0
- package/dist/normalize-input-layers-marks.js +2 -0
- package/dist/normalize-input-layers-marks.js.map +1 -0
- package/dist/normalize-input-layers-special.d.ts +131 -0
- package/dist/normalize-input-layers-special.d.ts.map +1 -0
- package/dist/normalize-input-layers-special.js +2 -0
- package/dist/normalize-input-layers-special.js.map +1 -0
- package/dist/normalize-input.d.ts +81 -0
- package/dist/normalize-input.d.ts.map +1 -0
- package/dist/normalize-input.js +2 -0
- package/dist/normalize-input.js.map +1 -0
- package/dist/normalize-paint.d.ts +8 -0
- package/dist/normalize-paint.d.ts.map +1 -0
- package/dist/normalize-paint.js +83 -0
- package/dist/normalize-paint.js.map +1 -0
- package/dist/normalize-scales.d.ts +7 -0
- package/dist/normalize-scales.d.ts.map +1 -0
- package/dist/normalize-scales.js +90 -0
- package/dist/normalize-scales.js.map +1 -0
- package/dist/normalize.d.ts +46 -0
- package/dist/normalize.d.ts.map +1 -0
- package/dist/normalize.js +279 -0
- package/dist/normalize.js.map +1 -0
- package/dist/paint-helpers.d.ts +45 -0
- package/dist/paint-helpers.d.ts.map +1 -0
- package/dist/paint-helpers.js +48 -0
- package/dist/paint-helpers.js.map +1 -0
- package/dist/pipeline-error-catalog.d.ts +319 -0
- package/dist/pipeline-error-catalog.d.ts.map +1 -0
- package/dist/pipeline-error-catalog.js +260 -0
- package/dist/pipeline-error-catalog.js.map +1 -0
- package/dist/portability-check.d.ts +35 -0
- package/dist/portability-check.d.ts.map +1 -0
- package/dist/portability-check.js +121 -0
- package/dist/portability-check.js.map +1 -0
- package/dist/portability-lossy.d.ts +19 -0
- package/dist/portability-lossy.d.ts.map +1 -0
- package/dist/portability-lossy.js +65 -0
- package/dist/portability-lossy.js.map +1 -0
- package/dist/portability.d.ts +23 -0
- package/dist/portability.d.ts.map +1 -0
- package/dist/portability.js +23 -0
- package/dist/portability.js.map +1 -0
- package/dist/portable-builder.d.ts +215 -0
- package/dist/portable-builder.d.ts.map +1 -0
- package/dist/portable-builder.js +27 -0
- package/dist/portable-builder.js.map +1 -0
- package/dist/portable-entry.d.ts +16 -0
- package/dist/portable-entry.d.ts.map +1 -0
- package/dist/portable-entry.js +14 -0
- package/dist/portable-entry.js.map +1 -0
- package/dist/position-reference-build.d.ts +29 -0
- package/dist/position-reference-build.d.ts.map +1 -0
- package/dist/position-reference-build.js +115 -0
- package/dist/position-reference-build.js.map +1 -0
- package/dist/position-reference.d.ts +34 -0
- package/dist/position-reference.d.ts.map +1 -0
- package/dist/position-reference.js +19 -0
- package/dist/position-reference.js.map +1 -0
- package/dist/runtime.d.ts +139 -0
- package/dist/runtime.d.ts.map +1 -0
- package/dist/runtime.js +2 -0
- package/dist/runtime.js.map +1 -0
- package/dist/scale-color-helpers.d.ts +121 -0
- package/dist/scale-color-helpers.d.ts.map +1 -0
- package/dist/scale-color-helpers.js +188 -0
- package/dist/scale-color-helpers.js.map +1 -0
- package/dist/scale-color-hue-grey.d.ts +52 -0
- package/dist/scale-color-hue-grey.d.ts.map +1 -0
- package/dist/scale-color-hue-grey.js +60 -0
- package/dist/scale-color-hue-grey.js.map +1 -0
- package/dist/scale-color-stops.d.ts +85 -0
- package/dist/scale-color-stops.d.ts.map +1 -0
- package/dist/scale-color-stops.js +87 -0
- package/dist/scale-color-stops.js.map +1 -0
- package/dist/scale-color-viridis.d.ts +52 -0
- package/dist/scale-color-viridis.d.ts.map +1 -0
- package/dist/scale-color-viridis.js +68 -0
- package/dist/scale-color-viridis.js.map +1 -0
- package/dist/scale-helpers.d.ts +20 -0
- package/dist/scale-helpers.d.ts.map +1 -0
- package/dist/scale-helpers.js +20 -0
- package/dist/scale-helpers.js.map +1 -0
- package/dist/scale-multi-helpers.d.ts +61 -0
- package/dist/scale-multi-helpers.d.ts.map +1 -0
- package/dist/scale-multi-helpers.js +147 -0
- package/dist/scale-multi-helpers.js.map +1 -0
- package/dist/scale-position-helpers.d.ts +81 -0
- package/dist/scale-position-helpers.d.ts.map +1 -0
- package/dist/scale-position-helpers.js +133 -0
- package/dist/scale-position-helpers.js.map +1 -0
- package/dist/scale-reference-build.d.ts +50 -0
- package/dist/scale-reference-build.d.ts.map +1 -0
- package/dist/scale-reference-build.js +147 -0
- package/dist/scale-reference-build.js.map +1 -0
- package/dist/scale-reference-classify-color.d.ts +11 -0
- package/dist/scale-reference-classify-color.d.ts.map +1 -0
- package/dist/scale-reference-classify-color.js +292 -0
- package/dist/scale-reference-classify-color.js.map +1 -0
- package/dist/scale-reference-classify-position.d.ts +10 -0
- package/dist/scale-reference-classify-position.d.ts.map +1 -0
- package/dist/scale-reference-classify-position.js +137 -0
- package/dist/scale-reference-classify-position.js.map +1 -0
- package/dist/scale-reference-classify-style.d.ts +10 -0
- package/dist/scale-reference-classify-style.d.ts.map +1 -0
- package/dist/scale-reference-classify-style.js +194 -0
- package/dist/scale-reference-classify-style.js.map +1 -0
- package/dist/scale-reference-classify-support.d.ts +37 -0
- package/dist/scale-reference-classify-support.d.ts.map +1 -0
- package/dist/scale-reference-classify-support.js +206 -0
- package/dist/scale-reference-classify-support.js.map +1 -0
- package/dist/scale-reference.d.ts +80 -0
- package/dist/scale-reference.d.ts.map +1 -0
- package/dist/scale-reference.js +85 -0
- package/dist/scale-reference.js.map +1 -0
- package/dist/scale-style-helpers.d.ts +158 -0
- package/dist/scale-style-helpers.d.ts.map +1 -0
- package/dist/scale-style-helpers.js +197 -0
- package/dist/scale-style-helpers.js.map +1 -0
- package/dist/schema-catalog.d.ts +62 -0
- package/dist/schema-catalog.d.ts.map +1 -0
- package/dist/schema-catalog.js +208 -0
- package/dist/schema-catalog.js.map +1 -0
- package/dist/schema-declarations.d.ts +1585 -0
- package/dist/schema-declarations.d.ts.map +1 -0
- package/dist/schema-declarations.js +51 -0
- package/dist/schema-declarations.js.map +1 -0
- package/dist/schema-decls-data.d.ts +58 -0
- package/dist/schema-decls-data.d.ts.map +1 -0
- package/dist/schema-decls-data.js +151 -0
- package/dist/schema-decls-data.js.map +1 -0
- package/dist/schema-decls-guides-theme.d.ts +166 -0
- package/dist/schema-decls-guides-theme.d.ts.map +1 -0
- package/dist/schema-decls-guides-theme.js +251 -0
- package/dist/schema-decls-guides-theme.js.map +1 -0
- package/dist/schema-decls-layers-col-boxplot.d.ts +118 -0
- package/dist/schema-decls-layers-col-boxplot.d.ts.map +1 -0
- package/dist/schema-decls-layers-col-boxplot.js +239 -0
- package/dist/schema-decls-layers-col-boxplot.js.map +1 -0
- package/dist/schema-decls-layers-count-pointrange.d.ts +89 -0
- package/dist/schema-decls-layers-count-pointrange.d.ts.map +1 -0
- package/dist/schema-decls-layers-count-pointrange.js +190 -0
- package/dist/schema-decls-layers-count-pointrange.js.map +1 -0
- package/dist/schema-decls-layers-crossbar-jitter.d.ts +129 -0
- package/dist/schema-decls-layers-crossbar-jitter.d.ts.map +1 -0
- package/dist/schema-decls-layers-crossbar-jitter.js +255 -0
- package/dist/schema-decls-layers-crossbar-jitter.js.map +1 -0
- package/dist/schema-decls-layers-point-path.d.ts +49 -0
- package/dist/schema-decls-layers-point-path.d.ts.map +1 -0
- package/dist/schema-decls-layers-point-path.js +156 -0
- package/dist/schema-decls-layers-point-path.js.map +1 -0
- package/dist/schema-decls-layers-sf-blank.d.ts +89 -0
- package/dist/schema-decls-layers-sf-blank.d.ts.map +1 -0
- package/dist/schema-decls-layers-sf-blank.js +254 -0
- package/dist/schema-decls-layers-sf-blank.js.map +1 -0
- package/dist/schema-decls-layers-text-map.d.ts +80 -0
- package/dist/schema-decls-layers-text-map.d.ts.map +1 -0
- package/dist/schema-decls-layers-text-map.js +151 -0
- package/dist/schema-decls-layers-text-map.js.map +1 -0
- package/dist/schema-decls-paint.d.ts +39 -0
- package/dist/schema-decls-paint.d.ts.map +1 -0
- package/dist/schema-decls-paint.js +95 -0
- package/dist/schema-decls-paint.js.map +1 -0
- package/dist/schema-decls-params-area-abline.d.ts +85 -0
- package/dist/schema-decls-params-area-abline.d.ts.map +1 -0
- package/dist/schema-decls-params-area-abline.js +259 -0
- package/dist/schema-decls-params-area-abline.js.map +1 -0
- package/dist/schema-decls-params-col-contour.d.ts +61 -0
- package/dist/schema-decls-params-col-contour.d.ts.map +1 -0
- package/dist/schema-decls-params-col-contour.js +202 -0
- package/dist/schema-decls-params-col-contour.js.map +1 -0
- package/dist/schema-decls-params-curve-label.d.ts +64 -0
- package/dist/schema-decls-params-curve-label.d.ts.map +1 -0
- package/dist/schema-decls-params-curve-label.js +204 -0
- package/dist/schema-decls-params-curve-label.js.map +1 -0
- package/dist/schema-decls-params-errorbar-position.d.ts +83 -0
- package/dist/schema-decls-params-errorbar-position.d.ts.map +1 -0
- package/dist/schema-decls-params-errorbar-position.js +264 -0
- package/dist/schema-decls-params-errorbar-position.js.map +1 -0
- package/dist/schema-decls-params-point-path.d.ts +61 -0
- package/dist/schema-decls-params-point-path.d.ts.map +1 -0
- package/dist/schema-decls-params-point-path.js +240 -0
- package/dist/schema-decls-params-point-path.js.map +1 -0
- package/dist/schema-decls-params-violin-summary.d.ts +78 -0
- package/dist/schema-decls-params-violin-summary.d.ts.map +1 -0
- package/dist/schema-decls-params-violin-summary.js +272 -0
- package/dist/schema-decls-params-violin-summary.js.map +1 -0
- package/dist/schema-decls-plot.d.ts +80 -0
- package/dist/schema-decls-plot.d.ts.map +1 -0
- package/dist/schema-decls-plot.js +222 -0
- package/dist/schema-decls-plot.js.map +1 -0
- package/dist/schema-decls-scales-guides.d.ts +291 -0
- package/dist/schema-decls-scales-guides.d.ts.map +1 -0
- package/dist/schema-decls-scales-guides.js +189 -0
- package/dist/schema-decls-scales-guides.js.map +1 -0
- package/dist/schema-decls-scales.d.ts +124 -0
- package/dist/schema-decls-scales.d.ts.map +1 -0
- package/dist/schema-decls-scales.js +279 -0
- package/dist/schema-decls-scales.js.map +1 -0
- package/dist/schema-imports.d.ts +1679 -0
- package/dist/schema-imports.d.ts.map +1 -0
- package/dist/schema-imports.js +104 -0
- package/dist/schema-imports.js.map +1 -0
- package/dist/schema-name-schemas.d.ts +18 -0
- package/dist/schema-name-schemas.d.ts.map +1 -0
- package/dist/schema-name-schemas.js +13 -0
- package/dist/schema-name-schemas.js.map +1 -0
- package/dist/schema-names.d.ts +53 -0
- package/dist/schema-names.d.ts.map +1 -0
- package/dist/schema-names.js +229 -0
- package/dist/schema-names.js.map +1 -0
- package/dist/schema-types.d.ts +336 -0
- package/dist/schema-types.d.ts.map +1 -0
- package/dist/schema-types.js +10 -0
- package/dist/schema-types.js.map +1 -0
- package/dist/schema.d.ts +38 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +34 -0
- package/dist/schema.js.map +1 -0
- package/dist/stat-reference-build.d.ts +24 -0
- package/dist/stat-reference-build.d.ts.map +1 -0
- package/dist/stat-reference-build.js +86 -0
- package/dist/stat-reference-build.js.map +1 -0
- package/dist/stat-reference.d.ts +33 -0
- package/dist/stat-reference.d.ts.map +1 -0
- package/dist/stat-reference.js +19 -0
- package/dist/stat-reference.js.map +1 -0
- package/dist/structural-gate.d.ts +15 -0
- package/dist/structural-gate.d.ts.map +1 -0
- package/dist/structural-gate.js +34 -0
- package/dist/structural-gate.js.map +1 -0
- package/dist/temporal-column.d.ts +33 -0
- package/dist/temporal-column.d.ts.map +1 -0
- package/dist/temporal-column.js +247 -0
- package/dist/temporal-column.js.map +1 -0
- package/dist/temporal-guides.d.ts +11 -0
- package/dist/temporal-guides.d.ts.map +1 -0
- package/dist/temporal-guides.js +11 -0
- package/dist/temporal-guides.js.map +1 -0
- package/dist/temporal-interval-schema.d.ts +9 -0
- package/dist/temporal-interval-schema.d.ts.map +1 -0
- package/dist/temporal-interval-schema.js +25 -0
- package/dist/temporal-interval-schema.js.map +1 -0
- package/dist/temporal-interval.d.ts +29 -0
- package/dist/temporal-interval.d.ts.map +1 -0
- package/dist/temporal-interval.js +122 -0
- package/dist/temporal-interval.js.map +1 -0
- package/dist/temporal-parse-core.d.ts +96 -0
- package/dist/temporal-parse-core.d.ts.map +1 -0
- package/dist/temporal-parse-core.js +235 -0
- package/dist/temporal-parse-core.js.map +1 -0
- package/dist/temporal-parse-format.d.ts +13 -0
- package/dist/temporal-parse-format.d.ts.map +1 -0
- package/dist/temporal-parse-format.js +180 -0
- package/dist/temporal-parse-format.js.map +1 -0
- package/dist/temporal-parse-schema.d.ts +11 -0
- package/dist/temporal-parse-schema.d.ts.map +1 -0
- package/dist/temporal-parse-schema.js +23 -0
- package/dist/temporal-parse-schema.js.map +1 -0
- package/dist/temporal-parse.d.ts +18 -0
- package/dist/temporal-parse.d.ts.map +1 -0
- package/dist/temporal-parse.js +183 -0
- package/dist/temporal-parse.js.map +1 -0
- package/dist/temporal-polyfill.d.ts +3 -0
- package/dist/temporal-polyfill.d.ts.map +1 -0
- package/dist/temporal-polyfill.js +25 -0
- package/dist/temporal-polyfill.js.map +1 -0
- package/dist/temporal-ticks.d.ts +20 -0
- package/dist/temporal-ticks.d.ts.map +1 -0
- package/dist/temporal-ticks.js +246 -0
- package/dist/temporal-ticks.js.map +1 -0
- package/dist/temporal.d.ts +109 -0
- package/dist/temporal.d.ts.map +1 -0
- package/dist/temporal.js +73 -0
- package/dist/temporal.js.map +1 -0
- package/dist/validate-data-checks-color-temporal.d.ts +58 -0
- package/dist/validate-data-checks-color-temporal.d.ts.map +1 -0
- package/dist/validate-data-checks-color-temporal.js +168 -0
- package/dist/validate-data-checks-color-temporal.js.map +1 -0
- package/dist/validate-data-checks-color.d.ts +28 -0
- package/dist/validate-data-checks-color.d.ts.map +1 -0
- package/dist/validate-data-checks-color.js +296 -0
- package/dist/validate-data-checks-color.js.map +1 -0
- package/dist/validate-data-checks-layer.d.ts +37 -0
- package/dist/validate-data-checks-layer.d.ts.map +1 -0
- package/dist/validate-data-checks-layer.js +343 -0
- package/dist/validate-data-checks-layer.js.map +1 -0
- package/dist/validate-data-checks-position.d.ts +45 -0
- package/dist/validate-data-checks-position.d.ts.map +1 -0
- package/dist/validate-data-checks-position.js +204 -0
- package/dist/validate-data-checks-position.js.map +1 -0
- package/dist/validate-data-checks-style-finite.d.ts +24 -0
- package/dist/validate-data-checks-style-finite.d.ts.map +1 -0
- package/dist/validate-data-checks-style-finite.js +40 -0
- package/dist/validate-data-checks-style-finite.js.map +1 -0
- package/dist/validate-data-checks-style-numeric.d.ts +26 -0
- package/dist/validate-data-checks-style-numeric.d.ts.map +1 -0
- package/dist/validate-data-checks-style-numeric.js +327 -0
- package/dist/validate-data-checks-style-numeric.js.map +1 -0
- package/dist/validate-data-checks-style.d.ts +14 -0
- package/dist/validate-data-checks-style.d.ts.map +1 -0
- package/dist/validate-data-checks-style.js +14 -0
- package/dist/validate-data-checks-style.js.map +1 -0
- package/dist/validate-data-checks-temporal.d.ts +57 -0
- package/dist/validate-data-checks-temporal.d.ts.map +1 -0
- package/dist/validate-data-checks-temporal.js +83 -0
- package/dist/validate-data-checks-temporal.js.map +1 -0
- package/dist/validate-data-checks.d.ts +31 -0
- package/dist/validate-data-checks.d.ts.map +1 -0
- package/dist/validate-data-checks.js +110 -0
- package/dist/validate-data-checks.js.map +1 -0
- package/dist/validate-data-evidence.d.ts +69 -0
- package/dist/validate-data-evidence.d.ts.map +1 -0
- package/dist/validate-data-evidence.js +329 -0
- package/dist/validate-data-evidence.js.map +1 -0
- package/dist/validate-data.d.ts +73 -0
- package/dist/validate-data.d.ts.map +1 -0
- package/dist/validate-data.js +30 -0
- package/dist/validate-data.js.map +1 -0
- package/dist/validate-map-errors.d.ts +32 -0
- package/dist/validate-map-errors.d.ts.map +1 -0
- package/dist/validate-map-errors.js +76 -0
- package/dist/validate-map-errors.js.map +1 -0
- package/dist/validate-map-forms.d.ts +43 -0
- package/dist/validate-map-forms.d.ts.map +1 -0
- package/dist/validate-map-forms.js +125 -0
- package/dist/validate-map-forms.js.map +1 -0
- package/dist/validate-map-path-keywords.d.ts +11 -0
- package/dist/validate-map-path-keywords.d.ts.map +1 -0
- package/dist/validate-map-path-keywords.js +95 -0
- package/dist/validate-map-path-keywords.js.map +1 -0
- package/dist/validate-map-path-unions.d.ts +27 -0
- package/dist/validate-map-path-unions.d.ts.map +1 -0
- package/dist/validate-map-path-unions.js +200 -0
- package/dist/validate-map-path-unions.js.map +1 -0
- package/dist/validate-schema-shape.d.ts +69 -0
- package/dist/validate-schema-shape.d.ts.map +1 -0
- package/dist/validate-schema-shape.js +156 -0
- package/dist/validate-schema-shape.js.map +1 -0
- package/dist/validate-schema-walk.d.ts +34 -0
- package/dist/validate-schema-walk.d.ts.map +1 -0
- package/dist/validate-schema-walk.js +216 -0
- package/dist/validate-schema-walk.js.map +1 -0
- package/dist/validate-structure-facet.d.ts +8 -0
- package/dist/validate-structure-facet.d.ts.map +1 -0
- package/dist/validate-structure-facet.js +67 -0
- package/dist/validate-structure-facet.js.map +1 -0
- package/dist/validate-structure-layer-computed-y.d.ts +14 -0
- package/dist/validate-structure-layer-computed-y.d.ts.map +1 -0
- package/dist/validate-structure-layer-computed-y.js +70 -0
- package/dist/validate-structure-layer-computed-y.js.map +1 -0
- package/dist/validate-structure-layer-ribbon.d.ts +8 -0
- package/dist/validate-structure-layer-ribbon.d.ts.map +1 -0
- package/dist/validate-structure-layer-ribbon.js +36 -0
- package/dist/validate-structure-layer-ribbon.js.map +1 -0
- package/dist/validate-structure-layer-rule.d.ts +14 -0
- package/dist/validate-structure-layer-rule.d.ts.map +1 -0
- package/dist/validate-structure-layer-rule.js +90 -0
- package/dist/validate-structure-layer-rule.js.map +1 -0
- package/dist/validate-structure-layer-shared.d.ts +12 -0
- package/dist/validate-structure-layer-shared.d.ts.map +1 -0
- package/dist/validate-structure-layer-shared.js +17 -0
- package/dist/validate-structure-layer-shared.js.map +1 -0
- package/dist/validate-structure-layers.d.ts +12 -0
- package/dist/validate-structure-layers.d.ts.map +1 -0
- package/dist/validate-structure-layers.js +292 -0
- package/dist/validate-structure-layers.js.map +1 -0
- package/dist/validate-structure-paint.d.ts +12 -0
- package/dist/validate-structure-paint.d.ts.map +1 -0
- package/dist/validate-structure-paint.js +87 -0
- package/dist/validate-structure-paint.js.map +1 -0
- package/dist/validate-structure-scales.d.ts +10 -0
- package/dist/validate-structure-scales.d.ts.map +1 -0
- package/dist/validate-structure-scales.js +242 -0
- package/dist/validate-structure-scales.js.map +1 -0
- package/dist/validate-structure-style-bins.d.ts +17 -0
- package/dist/validate-structure-style-bins.d.ts.map +1 -0
- package/dist/validate-structure-style-bins.js +150 -0
- package/dist/validate-structure-style-bins.js.map +1 -0
- package/dist/validate-structure.d.ts +16 -0
- package/dist/validate-structure.d.ts.map +1 -0
- package/dist/validate-structure.js +16 -0
- package/dist/validate-structure.js.map +1 -0
- package/dist/validate.d.ts +24 -0
- package/dist/validate.d.ts.map +1 -0
- package/dist/validate.js +178 -0
- package/dist/validate.js.map +1 -0
- package/package.json +59 -0
- package/schema/v0.json +9618 -0
- package/src/artifact.ts +81 -0
- package/src/builder-core.ts +276 -0
- package/src/builder-data.ts +156 -0
- package/src/builder-geoms.ts +290 -0
- package/src/builder-options.ts +428 -0
- package/src/builder-scales.ts +443 -0
- package/src/builder.ts +125 -0
- package/src/capabilities-data.ts +336 -0
- package/src/capabilities-helpers.ts +54 -0
- package/src/capabilities.ts +159 -0
- package/src/coord-helpers.ts +177 -0
- package/src/coord-reference-build.ts +283 -0
- package/src/coord-reference.ts +75 -0
- package/src/error-catalog.ts +253 -0
- package/src/error-prose-shared.ts +106 -0
- package/src/errors.ts +87 -0
- package/src/generated/coord-reference-data.ts +235 -0
- package/src/generated/geom-param-keys.ts +222 -0
- package/src/generated/geom-reference-data.ts +3024 -0
- package/src/generated/guide-reference-data.ts +284 -0
- package/src/generated/plot-spec-validator.ts +7335 -0
- package/src/generated/position-reference-data.ts +191 -0
- package/src/generated/scale-reference-data.ts +10665 -0
- package/src/generated/stat-reference-data.ts +339 -0
- package/src/geom-params-build.ts +92 -0
- package/src/geom-params.ts +14 -0
- package/src/geom-reference-build.ts +292 -0
- package/src/geom-reference.ts +127 -0
- package/src/guide-helpers.ts +44 -0
- package/src/guide-reference-build.ts +249 -0
- package/src/guide-reference.ts +76 -0
- package/src/hue-grey-palettes.ts +82 -0
- package/src/index.ts +400 -0
- package/src/lint-catalog.ts +57 -0
- package/src/lint-layer-rules.ts +175 -0
- package/src/lint-scale-rules.ts +285 -0
- package/src/lint.ts +126 -0
- package/src/normalize-coord.ts +126 -0
- package/src/normalize-input-layers-marks.ts +276 -0
- package/src/normalize-input-layers-special.ts +252 -0
- package/src/normalize-input.ts +154 -0
- package/src/normalize-paint.ts +98 -0
- package/src/normalize-scales.ts +108 -0
- package/src/normalize.ts +403 -0
- package/src/paint-helpers.ts +98 -0
- package/src/pipeline-error-catalog.ts +278 -0
- package/src/portability-check.ts +155 -0
- package/src/portability-lossy.ts +81 -0
- package/src/portability.ts +31 -0
- package/src/portable-builder.ts +35 -0
- package/src/portable-entry.ts +37 -0
- package/src/position-reference-build.ts +164 -0
- package/src/position-reference.ts +41 -0
- package/src/runtime.ts +198 -0
- package/src/scale-color-helpers.ts +263 -0
- package/src/scale-color-hue-grey.ts +95 -0
- package/src/scale-color-stops.ts +177 -0
- package/src/scale-color-viridis.ts +99 -0
- package/src/scale-helpers.ts +264 -0
- package/src/scale-multi-helpers.ts +220 -0
- package/src/scale-position-helpers.ts +231 -0
- package/src/scale-reference-build.ts +222 -0
- package/src/scale-reference-classify-color.ts +334 -0
- package/src/scale-reference-classify-position.ts +164 -0
- package/src/scale-reference-classify-style.ts +229 -0
- package/src/scale-reference-classify-support.ts +298 -0
- package/src/scale-reference.ts +165 -0
- package/src/scale-style-helpers.ts +316 -0
- package/src/schema-catalog.ts +222 -0
- package/src/schema-declarations.ts +51 -0
- package/src/schema-decls-data.ts +272 -0
- package/src/schema-decls-guides-theme.ts +395 -0
- package/src/schema-decls-layers-col-boxplot.ts +410 -0
- package/src/schema-decls-layers-count-pointrange.ts +321 -0
- package/src/schema-decls-layers-crossbar-jitter.ts +443 -0
- package/src/schema-decls-layers-point-path.ts +246 -0
- package/src/schema-decls-layers-sf-blank.ts +408 -0
- package/src/schema-decls-layers-text-map.ts +259 -0
- package/src/schema-decls-paint.ts +124 -0
- package/src/schema-decls-params-area-abline.ts +440 -0
- package/src/schema-decls-params-col-contour.ts +333 -0
- package/src/schema-decls-params-curve-label.ts +343 -0
- package/src/schema-decls-params-errorbar-position.ts +446 -0
- package/src/schema-decls-params-point-path.ts +394 -0
- package/src/schema-decls-params-violin-summary.ts +447 -0
- package/src/schema-decls-plot.ts +385 -0
- package/src/schema-decls-scales-guides.ts +233 -0
- package/src/schema-decls-scales.ts +432 -0
- package/src/schema-imports.ts +116 -0
- package/src/schema-name-schemas.ts +37 -0
- package/src/schema-names.ts +243 -0
- package/src/schema-types.ts +400 -0
- package/src/schema.ts +287 -0
- package/src/stat-reference-build.ts +145 -0
- package/src/stat-reference.ts +38 -0
- package/src/structural-gate.ts +42 -0
- package/src/temporal-column.ts +323 -0
- package/src/temporal-guides.ts +32 -0
- package/src/temporal-interval-schema.ts +40 -0
- package/src/temporal-interval.ts +151 -0
- package/src/temporal-parse-core.ts +331 -0
- package/src/temporal-parse-format.ts +222 -0
- package/src/temporal-parse-schema.ts +38 -0
- package/src/temporal-parse.ts +259 -0
- package/src/temporal-polyfill.ts +27 -0
- package/src/temporal-ticks.ts +312 -0
- package/src/temporal.ts +112 -0
- package/src/validate-data-checks-color-temporal.ts +261 -0
- package/src/validate-data-checks-color.ts +395 -0
- package/src/validate-data-checks-layer.ts +492 -0
- package/src/validate-data-checks-position.ts +275 -0
- package/src/validate-data-checks-style-finite.ts +55 -0
- package/src/validate-data-checks-style-numeric.ts +455 -0
- package/src/validate-data-checks-style.ts +13 -0
- package/src/validate-data-checks-temporal.ts +129 -0
- package/src/validate-data-checks.ts +157 -0
- package/src/validate-data-evidence.ts +419 -0
- package/src/validate-data.ts +114 -0
- package/src/validate-map-errors.ts +126 -0
- package/src/validate-map-forms.ts +148 -0
- package/src/validate-map-path-keywords.ts +129 -0
- package/src/validate-map-path-unions.ts +281 -0
- package/src/validate-schema-shape.ts +232 -0
- package/src/validate-schema-walk.ts +219 -0
- package/src/validate-structure-facet.ts +76 -0
- package/src/validate-structure-layer-computed-y.ts +94 -0
- package/src/validate-structure-layer-ribbon.ts +61 -0
- package/src/validate-structure-layer-rule.ts +98 -0
- package/src/validate-structure-layer-shared.ts +29 -0
- package/src/validate-structure-layers.ts +395 -0
- package/src/validate-structure-paint.ts +101 -0
- package/src/validate-structure-scales.ts +278 -0
- package/src/validate-structure-style-bins.ts +167 -0
- package/src/validate-structure.ts +16 -0
- package/src/validate.ts +212 -0
|
@@ -0,0 +1,2790 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* AUTO-GENERATED by scripts/gen-reference-catalogs.ts — do not edit by hand.
|
|
3
|
+
* Regenerate: bun run reference:catalogs:gen
|
|
4
|
+
*
|
|
5
|
+
* GEOM_REFERENCE — per-geom API docs from SpecDeclarations.
|
|
6
|
+
*/
|
|
7
|
+
export const GEOM_REFERENCE_DATA = {
|
|
8
|
+
point: {
|
|
9
|
+
name: "point",
|
|
10
|
+
slug: "point",
|
|
11
|
+
component: "GeomPoint",
|
|
12
|
+
summary: "Point geometry: one mark per data row. Use for scatter plots, dot plots, bubbles, and correlation views.",
|
|
13
|
+
defaultStat: "identity",
|
|
14
|
+
defaultPosition: "identity",
|
|
15
|
+
allowedStats: ["identity", "unique", "summary_bin", "summary_rolling", "manual", "sum"],
|
|
16
|
+
allowedPositions: ["identity", "jitter", "nudge"],
|
|
17
|
+
paramsType: "PointParams",
|
|
18
|
+
params: [
|
|
19
|
+
{
|
|
20
|
+
name: "alpha",
|
|
21
|
+
description: "Point opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
22
|
+
typeSummary: "number",
|
|
23
|
+
required: false,
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
name: "size",
|
|
27
|
+
description: "Point radius in px. Must be greater than 0. Default 2.5.",
|
|
28
|
+
typeSummary: "number",
|
|
29
|
+
required: false,
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
name: "shape",
|
|
33
|
+
description: 'Point shape. One of "circle", "triangle", "square", "diamond", "plus", "cross", "circle-open". Default "circle".',
|
|
34
|
+
typeSummary: '"circle" | "triangle" | "square" | "diamond" | "plus" | "cross" | "circle-open"',
|
|
35
|
+
required: false,
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
name: "bins",
|
|
39
|
+
description: "STAT SUMMARY_BIN ONLY: number of bins (integer ≥ 1). Default 30 — advisory. Overridden by binwidth.",
|
|
40
|
+
typeSummary: "number",
|
|
41
|
+
required: false,
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
name: "binwidth",
|
|
45
|
+
description: "STAT SUMMARY_BIN ONLY: bin width in data units (must be greater than 0). Takes precedence over bins.",
|
|
46
|
+
typeSummary: "number",
|
|
47
|
+
required: false,
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
name: "boundary",
|
|
51
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin EDGE with this x value. Mutually exclusive with center.",
|
|
52
|
+
typeSummary: "number",
|
|
53
|
+
required: false,
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
name: "center",
|
|
57
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
58
|
+
typeSummary: "number",
|
|
59
|
+
required: false,
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
name: "closed",
|
|
63
|
+
description: 'STAT SUMMARY_BIN ONLY: which edge of each bin is inclusive: "right" (default) or "left".',
|
|
64
|
+
typeSummary: '"right" | "left"',
|
|
65
|
+
required: false,
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
name: "window",
|
|
69
|
+
description: 'STAT SUMMARY_ROLLING ONLY: centered rolling-window width in x data units (must be greater than 0). Required when stat is "summary_rolling".',
|
|
70
|
+
typeSummary: "number",
|
|
71
|
+
required: false,
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
name: "fun",
|
|
75
|
+
description: 'SUMMARY_BIN / SUMMARY_ROLLING center fun (mean/median/sum;) or MANUAL named transform (first|last|mean|median|min|max|sum;). Required when stat is "manual".',
|
|
76
|
+
typeSummary: '"first" | "last" | "mean" | "median" | "min" | "max" | "sum"',
|
|
77
|
+
required: false,
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
name: "funMin",
|
|
81
|
+
description: "STAT SUMMARY_BIN ONLY: lower bound summary (ymin).",
|
|
82
|
+
typeSummary: "SummaryFun",
|
|
83
|
+
required: false,
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
name: "funMax",
|
|
87
|
+
description: "STAT SUMMARY_BIN ONLY: upper bound summary (ymax).",
|
|
88
|
+
typeSummary: "SummaryFun",
|
|
89
|
+
required: false,
|
|
90
|
+
},
|
|
91
|
+
],
|
|
92
|
+
},
|
|
93
|
+
line: {
|
|
94
|
+
name: "line",
|
|
95
|
+
slug: "line",
|
|
96
|
+
component: "GeomLine",
|
|
97
|
+
summary: "Line geometry: connects points in x order, one line per group (groups derive from discrete aesthetics such as color, or from aes.group). Use for time series, trends, and line charts. With stat ecdf, pair with step curves; with stat bin (freqpoly alias), y is computed from counts/density; with stat connect, successive points expand into connection vertices.",
|
|
98
|
+
defaultStat: "identity",
|
|
99
|
+
defaultPosition: "identity",
|
|
100
|
+
allowedStats: [
|
|
101
|
+
"identity",
|
|
102
|
+
"unique",
|
|
103
|
+
"bin",
|
|
104
|
+
"align",
|
|
105
|
+
"connect",
|
|
106
|
+
"summary_bin",
|
|
107
|
+
"summary_rolling",
|
|
108
|
+
"manual",
|
|
109
|
+
"ecdf",
|
|
110
|
+
],
|
|
111
|
+
allowedPositions: ["identity"],
|
|
112
|
+
paramsType: "LineParams",
|
|
113
|
+
params: [
|
|
114
|
+
{
|
|
115
|
+
name: "alpha",
|
|
116
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
117
|
+
typeSummary: "number",
|
|
118
|
+
required: false,
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
name: "linewidth",
|
|
122
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.5.",
|
|
123
|
+
typeSummary: "number",
|
|
124
|
+
required: false,
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
name: "curve",
|
|
128
|
+
description: 'Interpolation: "linear" (default), "step" (mid-x corners), "step-hv" (horizontal then vertical — correct for ECDF), or "step-vh".',
|
|
129
|
+
typeSummary: '"linear" | "step" | "step-hv" | "step-vh"',
|
|
130
|
+
required: false,
|
|
131
|
+
},
|
|
132
|
+
{
|
|
133
|
+
name: "pad",
|
|
134
|
+
description: "With stat ecdf: when true (default), prepend (xmin, 0) so step stairs start at zero. Finite-clamped.",
|
|
135
|
+
typeSummary: "boolean",
|
|
136
|
+
required: false,
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
name: "n",
|
|
140
|
+
description: "With stat ecdf: evaluate on n equally spaced x in [min, max] per group; omit for one point per unique x.",
|
|
141
|
+
typeSummary: "number",
|
|
142
|
+
required: false,
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
name: "connection",
|
|
146
|
+
description: 'STAT CONNECT ONLY: how successive points join — "hv" (default), "vh", "mid", or "linear". Ignored for other stats.',
|
|
147
|
+
typeSummary: '"hv" | "vh" | "mid" | "linear"',
|
|
148
|
+
required: false,
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
name: "bins",
|
|
152
|
+
description: "STAT BIN / SUMMARY_BIN: number of bins (integer ≥ 1). Default 30 — an advisory reminds you to pick a real value. Overridden by binwidth.",
|
|
153
|
+
typeSummary: "number",
|
|
154
|
+
required: false,
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
name: "binwidth",
|
|
158
|
+
description: "STAT BIN / SUMMARY_BIN: bin width in data units (must be greater than 0). Takes precedence over bins.",
|
|
159
|
+
typeSummary: "number",
|
|
160
|
+
required: false,
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
name: "boundary",
|
|
164
|
+
description: "STAT BIN / SUMMARY_BIN: align a bin EDGE with this x value. Mutually exclusive with center.",
|
|
165
|
+
typeSummary: "number",
|
|
166
|
+
required: false,
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
name: "center",
|
|
170
|
+
description: "STAT BIN / SUMMARY_BIN: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
171
|
+
typeSummary: "number",
|
|
172
|
+
required: false,
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
name: "closed",
|
|
176
|
+
description: 'STAT BIN / SUMMARY_BIN: which edge of each bin is inclusive: "right" (default) or "left".',
|
|
177
|
+
typeSummary: '"right" | "left"',
|
|
178
|
+
required: false,
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
name: "window",
|
|
182
|
+
description: 'STAT SUMMARY_ROLLING ONLY: centered rolling-window width in x data units (must be greater than 0). Required when stat is "summary_rolling".',
|
|
183
|
+
typeSummary: "number",
|
|
184
|
+
required: false,
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
name: "fun",
|
|
188
|
+
description: 'SUMMARY_BIN / SUMMARY_ROLLING center fun (mean/median/sum;) or MANUAL named transform (first|last|mean|median|min|max|sum;). Required when stat is "manual".',
|
|
189
|
+
typeSummary: '"first" | "last" | "mean" | "median" | "min" | "max" | "sum"',
|
|
190
|
+
required: false,
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
name: "funMin",
|
|
194
|
+
description: "STAT SUMMARY_BIN ONLY: lower bound summary (ymin).",
|
|
195
|
+
typeSummary: "SummaryFun",
|
|
196
|
+
required: false,
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
name: "funMax",
|
|
200
|
+
description: "STAT SUMMARY_BIN ONLY: upper bound summary (ymax).",
|
|
201
|
+
typeSummary: "SummaryFun",
|
|
202
|
+
required: false,
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
name: "strokePaint",
|
|
206
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
207
|
+
typeSummary: "GradientPaint",
|
|
208
|
+
required: false,
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
name: "glow",
|
|
212
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
213
|
+
typeSummary: "GlowSpec",
|
|
214
|
+
required: false,
|
|
215
|
+
},
|
|
216
|
+
],
|
|
217
|
+
},
|
|
218
|
+
path: {
|
|
219
|
+
name: "path",
|
|
220
|
+
slug: "path",
|
|
221
|
+
component: "GeomPath",
|
|
222
|
+
summary: "Path geometry: connects points in data (row) order within each group — unlike line, which sorts by x. Use for trajectories, loops, connected scatterplots, and ellipse rings (stat ellipse). With stat connect, successive points expand into connection vertices.",
|
|
223
|
+
defaultStat: "identity",
|
|
224
|
+
defaultPosition: "identity",
|
|
225
|
+
allowedStats: ["identity", "unique", "connect", "manual", "ellipse"],
|
|
226
|
+
allowedPositions: ["identity"],
|
|
227
|
+
paramsType: "PathParams",
|
|
228
|
+
params: [
|
|
229
|
+
{
|
|
230
|
+
name: "alpha",
|
|
231
|
+
description: "Path opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
232
|
+
typeSummary: "number",
|
|
233
|
+
required: false,
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
name: "linewidth",
|
|
237
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.5.",
|
|
238
|
+
typeSummary: "number",
|
|
239
|
+
required: false,
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
name: "curve",
|
|
243
|
+
description: 'Interpolation between points: "linear" (straight segments, default) or "step" (horizontal-then-vertical steps).',
|
|
244
|
+
typeSummary: '"linear" | "step"',
|
|
245
|
+
required: false,
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
name: "connection",
|
|
249
|
+
description: 'STAT CONNECT ONLY: how successive points join — "hv" (default), "vh", "mid", or "linear". Ignored for other stats.',
|
|
250
|
+
typeSummary: '"hv" | "vh" | "mid" | "linear"',
|
|
251
|
+
required: false,
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
name: "fun",
|
|
255
|
+
description: 'STAT MANUAL ONLY: portable named transform (first|last|mean|median|min|max|sum). Required when stat is "manual".',
|
|
256
|
+
typeSummary: '"first" | "last" | "mean" | "median" | "min" | "max" | "sum"',
|
|
257
|
+
required: false,
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
name: "level",
|
|
261
|
+
description: "STAT ELLIPSE ONLY: confidence level of the bivariate normal ellipse, strictly between 0 and 1. Default 0.95.",
|
|
262
|
+
typeSummary: "number",
|
|
263
|
+
required: false,
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
name: "type",
|
|
267
|
+
description: 'STAT ELLIPSE ONLY: construction type. Only "norm" (bivariate normal) is supported in v1.',
|
|
268
|
+
typeSummary: '"norm"',
|
|
269
|
+
required: false,
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
name: "segments",
|
|
273
|
+
description: "STAT ELLIPSE ONLY: number of perimeter samples before the closing duplicate (output length = segments + 1). Default 51.",
|
|
274
|
+
typeSummary: "number",
|
|
275
|
+
required: false,
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
name: "strokePaint",
|
|
279
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
280
|
+
typeSummary: "GradientPaint",
|
|
281
|
+
required: false,
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
name: "glow",
|
|
285
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
286
|
+
typeSummary: "GlowSpec",
|
|
287
|
+
required: false,
|
|
288
|
+
},
|
|
289
|
+
],
|
|
290
|
+
},
|
|
291
|
+
col: {
|
|
292
|
+
name: "col",
|
|
293
|
+
slug: "col",
|
|
294
|
+
component: "GeomCol",
|
|
295
|
+
summary: "Column geometry: one rectangle per data row, from the y baseline (zero) to the row's y value. Use when the data already contains the bar heights — prefer over GeomBar, which counts or bins.",
|
|
296
|
+
defaultStat: "identity",
|
|
297
|
+
defaultPosition: "stack",
|
|
298
|
+
allowedStats: ["identity", "unique"],
|
|
299
|
+
allowedPositions: ["stack", "fill", "dodge", "identity"],
|
|
300
|
+
paramsType: "ColParams",
|
|
301
|
+
params: [
|
|
302
|
+
{
|
|
303
|
+
name: "alpha",
|
|
304
|
+
description: "Bar opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
305
|
+
typeSummary: "number",
|
|
306
|
+
required: false,
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
name: "width",
|
|
310
|
+
description: "Bar width as a fraction of the band step. Must be greater than 0 and at most 1. Default 0.9.",
|
|
311
|
+
typeSummary: "number",
|
|
312
|
+
required: false,
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
name: "fillPaint",
|
|
316
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
317
|
+
typeSummary: "GradientPaint",
|
|
318
|
+
required: false,
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
name: "glow",
|
|
322
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
323
|
+
typeSummary: "GlowSpec",
|
|
324
|
+
required: false,
|
|
325
|
+
},
|
|
326
|
+
],
|
|
327
|
+
},
|
|
328
|
+
bar: {
|
|
329
|
+
name: "bar",
|
|
330
|
+
slug: "bar",
|
|
331
|
+
component: "GeomBar",
|
|
332
|
+
summary: "Bar geometry with counting or binning: one rectangle per distinct x value (stat count, discrete x) or per bin (stat bin, continuous x). Do not map aes.y — the stat computes it. Prefer GeomCol when bar heights are already in the data.",
|
|
333
|
+
defaultStat: "count",
|
|
334
|
+
defaultPosition: "stack",
|
|
335
|
+
allowedStats: ["count", "bin"],
|
|
336
|
+
allowedPositions: ["stack", "fill", "dodge", "identity"],
|
|
337
|
+
paramsType: "BarParams",
|
|
338
|
+
params: [
|
|
339
|
+
{
|
|
340
|
+
name: "alpha",
|
|
341
|
+
description: "Bar opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
342
|
+
typeSummary: "number",
|
|
343
|
+
required: false,
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
name: "width",
|
|
347
|
+
description: "Bar width as a fraction of the band step (count-stat bars only; binned bars span their bin). Must be greater than 0 and at most 1. Default 0.9.",
|
|
348
|
+
typeSummary: "number",
|
|
349
|
+
required: false,
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
name: "bins",
|
|
353
|
+
description: "STAT BIN ONLY: number of bins (an integer of at least 1). Default 30 — an advisory reminds you to pick a real value. Overridden by binwidth.",
|
|
354
|
+
typeSummary: "number",
|
|
355
|
+
required: false,
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
name: "binwidth",
|
|
359
|
+
description: "STAT BIN ONLY: bin width in data units (must be greater than 0). Takes precedence over bins. Usually the better knob: pick a width meaningful for the data.",
|
|
360
|
+
typeSummary: "number",
|
|
361
|
+
required: false,
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
name: "boundary",
|
|
365
|
+
description: "STAT BIN ONLY: align a bin EDGE with this x value (e.g. 0 puts bin edges at multiples of the width). Mutually exclusive with center.",
|
|
366
|
+
typeSummary: "number",
|
|
367
|
+
required: false,
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
name: "center",
|
|
371
|
+
description: "STAT BIN ONLY: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
372
|
+
typeSummary: "number",
|
|
373
|
+
required: false,
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
name: "closed",
|
|
377
|
+
description: 'STAT BIN ONLY: which edge of each bin is inclusive: "right" (default, matches) or "left".',
|
|
378
|
+
typeSummary: '"right" | "left"',
|
|
379
|
+
required: false,
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
name: "fillPaint",
|
|
383
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
384
|
+
typeSummary: "GradientPaint",
|
|
385
|
+
required: false,
|
|
386
|
+
},
|
|
387
|
+
{
|
|
388
|
+
name: "glow",
|
|
389
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
390
|
+
typeSummary: "GlowSpec",
|
|
391
|
+
required: false,
|
|
392
|
+
},
|
|
393
|
+
],
|
|
394
|
+
},
|
|
395
|
+
histogram: {
|
|
396
|
+
name: "histogram",
|
|
397
|
+
slug: "histogram",
|
|
398
|
+
component: "GeomHistogram",
|
|
399
|
+
summary: "Histogram geometry: a continuous x variable divided into bins, one bar per bin whose height is the count of rows (or the sum of aes.weight). Do not map aes.y — the bin stat computes it. Canonicalized by normalize() to a bar layer with stat bin.",
|
|
400
|
+
defaultStat: "bin",
|
|
401
|
+
defaultPosition: "stack",
|
|
402
|
+
allowedStats: ["bin"],
|
|
403
|
+
allowedPositions: ["stack", "fill", "dodge", "identity"],
|
|
404
|
+
paramsType: "BarParams",
|
|
405
|
+
params: [
|
|
406
|
+
{
|
|
407
|
+
name: "alpha",
|
|
408
|
+
description: "Bar opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
409
|
+
typeSummary: "number",
|
|
410
|
+
required: false,
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
name: "width",
|
|
414
|
+
description: "Bar width as a fraction of the band step (count-stat bars only; binned bars span their bin). Must be greater than 0 and at most 1. Default 0.9.",
|
|
415
|
+
typeSummary: "number",
|
|
416
|
+
required: false,
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
name: "bins",
|
|
420
|
+
description: "STAT BIN ONLY: number of bins (an integer of at least 1). Default 30 — an advisory reminds you to pick a real value. Overridden by binwidth.",
|
|
421
|
+
typeSummary: "number",
|
|
422
|
+
required: false,
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
name: "binwidth",
|
|
426
|
+
description: "STAT BIN ONLY: bin width in data units (must be greater than 0). Takes precedence over bins. Usually the better knob: pick a width meaningful for the data.",
|
|
427
|
+
typeSummary: "number",
|
|
428
|
+
required: false,
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
name: "boundary",
|
|
432
|
+
description: "STAT BIN ONLY: align a bin EDGE with this x value (e.g. 0 puts bin edges at multiples of the width). Mutually exclusive with center.",
|
|
433
|
+
typeSummary: "number",
|
|
434
|
+
required: false,
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
name: "center",
|
|
438
|
+
description: "STAT BIN ONLY: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
439
|
+
typeSummary: "number",
|
|
440
|
+
required: false,
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
name: "closed",
|
|
444
|
+
description: 'STAT BIN ONLY: which edge of each bin is inclusive: "right" (default, matches) or "left".',
|
|
445
|
+
typeSummary: '"right" | "left"',
|
|
446
|
+
required: false,
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
name: "fillPaint",
|
|
450
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
451
|
+
typeSummary: "GradientPaint",
|
|
452
|
+
required: false,
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
name: "glow",
|
|
456
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
457
|
+
typeSummary: "GlowSpec",
|
|
458
|
+
required: false,
|
|
459
|
+
},
|
|
460
|
+
],
|
|
461
|
+
aliasOf: "bar",
|
|
462
|
+
},
|
|
463
|
+
freqpoly: {
|
|
464
|
+
name: "freqpoly",
|
|
465
|
+
slug: "freqpoly",
|
|
466
|
+
component: "GeomFreqpoly",
|
|
467
|
+
summary: "Frequency polygon: continuous x binned like a histogram, drawn as a line through bin centers. Do not map aes.y — the bin stat computes it. Canonicalized by normalize() to a line layer with stat bin.",
|
|
468
|
+
defaultStat: "bin",
|
|
469
|
+
defaultPosition: "identity",
|
|
470
|
+
allowedStats: ["bin"],
|
|
471
|
+
allowedPositions: ["identity"],
|
|
472
|
+
paramsType: "LineParams",
|
|
473
|
+
params: [
|
|
474
|
+
{
|
|
475
|
+
name: "alpha",
|
|
476
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
477
|
+
typeSummary: "number",
|
|
478
|
+
required: false,
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
name: "linewidth",
|
|
482
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.5.",
|
|
483
|
+
typeSummary: "number",
|
|
484
|
+
required: false,
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
name: "curve",
|
|
488
|
+
description: 'Interpolation: "linear" (default), "step" (mid-x corners), "step-hv" (horizontal then vertical — correct for ECDF), or "step-vh".',
|
|
489
|
+
typeSummary: '"linear" | "step" | "step-hv" | "step-vh"',
|
|
490
|
+
required: false,
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
name: "pad",
|
|
494
|
+
description: "With stat ecdf: when true (default), prepend (xmin, 0) so step stairs start at zero. Finite-clamped.",
|
|
495
|
+
typeSummary: "boolean",
|
|
496
|
+
required: false,
|
|
497
|
+
},
|
|
498
|
+
{
|
|
499
|
+
name: "n",
|
|
500
|
+
description: "With stat ecdf: evaluate on n equally spaced x in [min, max] per group; omit for one point per unique x.",
|
|
501
|
+
typeSummary: "number",
|
|
502
|
+
required: false,
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
name: "connection",
|
|
506
|
+
description: 'STAT CONNECT ONLY: how successive points join — "hv" (default), "vh", "mid", or "linear". Ignored for other stats.',
|
|
507
|
+
typeSummary: '"hv" | "vh" | "mid" | "linear"',
|
|
508
|
+
required: false,
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
name: "bins",
|
|
512
|
+
description: "STAT BIN / SUMMARY_BIN: number of bins (integer ≥ 1). Default 30 — an advisory reminds you to pick a real value. Overridden by binwidth.",
|
|
513
|
+
typeSummary: "number",
|
|
514
|
+
required: false,
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
name: "binwidth",
|
|
518
|
+
description: "STAT BIN / SUMMARY_BIN: bin width in data units (must be greater than 0). Takes precedence over bins.",
|
|
519
|
+
typeSummary: "number",
|
|
520
|
+
required: false,
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
name: "boundary",
|
|
524
|
+
description: "STAT BIN / SUMMARY_BIN: align a bin EDGE with this x value. Mutually exclusive with center.",
|
|
525
|
+
typeSummary: "number",
|
|
526
|
+
required: false,
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
name: "center",
|
|
530
|
+
description: "STAT BIN / SUMMARY_BIN: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
531
|
+
typeSummary: "number",
|
|
532
|
+
required: false,
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
name: "closed",
|
|
536
|
+
description: 'STAT BIN / SUMMARY_BIN: which edge of each bin is inclusive: "right" (default) or "left".',
|
|
537
|
+
typeSummary: '"right" | "left"',
|
|
538
|
+
required: false,
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
name: "window",
|
|
542
|
+
description: 'STAT SUMMARY_ROLLING ONLY: centered rolling-window width in x data units (must be greater than 0). Required when stat is "summary_rolling".',
|
|
543
|
+
typeSummary: "number",
|
|
544
|
+
required: false,
|
|
545
|
+
},
|
|
546
|
+
{
|
|
547
|
+
name: "fun",
|
|
548
|
+
description: 'SUMMARY_BIN / SUMMARY_ROLLING center fun (mean/median/sum;) or MANUAL named transform (first|last|mean|median|min|max|sum;). Required when stat is "manual".',
|
|
549
|
+
typeSummary: '"first" | "last" | "mean" | "median" | "min" | "max" | "sum"',
|
|
550
|
+
required: false,
|
|
551
|
+
},
|
|
552
|
+
{
|
|
553
|
+
name: "funMin",
|
|
554
|
+
description: "STAT SUMMARY_BIN ONLY: lower bound summary (ymin).",
|
|
555
|
+
typeSummary: "SummaryFun",
|
|
556
|
+
required: false,
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
name: "funMax",
|
|
560
|
+
description: "STAT SUMMARY_BIN ONLY: upper bound summary (ymax).",
|
|
561
|
+
typeSummary: "SummaryFun",
|
|
562
|
+
required: false,
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
name: "strokePaint",
|
|
566
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
567
|
+
typeSummary: "GradientPaint",
|
|
568
|
+
required: false,
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
name: "glow",
|
|
572
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
573
|
+
typeSummary: "GlowSpec",
|
|
574
|
+
required: false,
|
|
575
|
+
},
|
|
576
|
+
],
|
|
577
|
+
aliasOf: "line",
|
|
578
|
+
},
|
|
579
|
+
area: {
|
|
580
|
+
name: "area",
|
|
581
|
+
slug: "area",
|
|
582
|
+
component: "GeomArea",
|
|
583
|
+
summary: "Area geometry: a filled region from the y baseline (zero) to the y value, connected in x order per group. Use for stacked composition-over-time charts. With stat align, series with different x samples share a common grid for stack/fill.",
|
|
584
|
+
defaultStat: "identity",
|
|
585
|
+
defaultPosition: "stack",
|
|
586
|
+
allowedStats: ["identity", "unique", "align"],
|
|
587
|
+
allowedPositions: ["stack", "fill", "dodge", "identity"],
|
|
588
|
+
paramsType: "AreaParams",
|
|
589
|
+
params: [
|
|
590
|
+
{
|
|
591
|
+
name: "alpha",
|
|
592
|
+
description: "Area fill opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
593
|
+
typeSummary: "number",
|
|
594
|
+
required: false,
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
name: "fillPaint",
|
|
598
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
599
|
+
typeSummary: "GradientPaint",
|
|
600
|
+
required: false,
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
name: "glow",
|
|
604
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
605
|
+
typeSummary: "GlowSpec",
|
|
606
|
+
required: false,
|
|
607
|
+
},
|
|
608
|
+
],
|
|
609
|
+
},
|
|
610
|
+
rule: {
|
|
611
|
+
name: "rule",
|
|
612
|
+
slug: "rule",
|
|
613
|
+
component: "GeomRule",
|
|
614
|
+
summary: "Rule geometry: reference lines spanning the panel. Two forms: (1) annotation — set params.xintercept and/or params.yintercept to fixed data values and map neither aes.x nor aes.y; (2) data-driven — map exactly one of aes.x (vertical rules) or aes.y (horizontal rules) to a field. Never mix the forms in one layer.",
|
|
615
|
+
defaultStat: "identity",
|
|
616
|
+
defaultPosition: "identity",
|
|
617
|
+
allowedStats: ["identity", "unique"],
|
|
618
|
+
allowedPositions: ["identity"],
|
|
619
|
+
paramsType: "RuleParams",
|
|
620
|
+
params: [
|
|
621
|
+
{
|
|
622
|
+
name: "xintercept",
|
|
623
|
+
description: "ANNOTATION FORM ONLY: draw a vertical rule at each of these fixed x positions. Mutually exclusive with mapping aes.x/aes.y on this layer.",
|
|
624
|
+
typeSummary: "RuleIntercept",
|
|
625
|
+
required: false,
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
name: "yintercept",
|
|
629
|
+
description: "ANNOTATION FORM ONLY: draw a horizontal rule at each of these fixed y positions. Mutually exclusive with mapping aes.x/aes.y on this layer.",
|
|
630
|
+
typeSummary: "RuleIntercept",
|
|
631
|
+
required: false,
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
name: "alpha",
|
|
635
|
+
description: "Rule opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
636
|
+
typeSummary: "number",
|
|
637
|
+
required: false,
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
name: "linewidth",
|
|
641
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
642
|
+
typeSummary: "number",
|
|
643
|
+
required: false,
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
name: "strokePaint",
|
|
647
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
648
|
+
typeSummary: "GradientPaint",
|
|
649
|
+
required: false,
|
|
650
|
+
},
|
|
651
|
+
{
|
|
652
|
+
name: "glow",
|
|
653
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
654
|
+
typeSummary: "GlowSpec",
|
|
655
|
+
required: false,
|
|
656
|
+
},
|
|
657
|
+
],
|
|
658
|
+
},
|
|
659
|
+
hline: {
|
|
660
|
+
name: "hline",
|
|
661
|
+
slug: "hline",
|
|
662
|
+
component: "GeomHline",
|
|
663
|
+
summary: "Horizontal reference-line alias. Canonicalized by normalize() to a rule layer. Annotation form: set params.yintercept. Data-driven form: map aes.y (inherited plot x is dropped so the one-axis rule contract holds).",
|
|
664
|
+
defaultStat: "identity",
|
|
665
|
+
defaultPosition: "identity",
|
|
666
|
+
allowedStats: ["identity"],
|
|
667
|
+
allowedPositions: ["identity"],
|
|
668
|
+
paramsType: "HlineParams",
|
|
669
|
+
params: [
|
|
670
|
+
{
|
|
671
|
+
name: "yintercept",
|
|
672
|
+
description: "ANNOTATION FORM ONLY: draw a horizontal rule at each of these fixed y positions. Mutually exclusive with mapping aes.y on this layer.",
|
|
673
|
+
typeSummary: "RuleIntercept",
|
|
674
|
+
required: false,
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
name: "alpha",
|
|
678
|
+
description: "Rule opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
679
|
+
typeSummary: "number",
|
|
680
|
+
required: false,
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
name: "linewidth",
|
|
684
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
685
|
+
typeSummary: "number",
|
|
686
|
+
required: false,
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
name: "strokePaint",
|
|
690
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
691
|
+
typeSummary: "GradientPaint",
|
|
692
|
+
required: false,
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
name: "glow",
|
|
696
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
697
|
+
typeSummary: "GlowSpec",
|
|
698
|
+
required: false,
|
|
699
|
+
},
|
|
700
|
+
],
|
|
701
|
+
aliasOf: "rule",
|
|
702
|
+
},
|
|
703
|
+
vline: {
|
|
704
|
+
name: "vline",
|
|
705
|
+
slug: "vline",
|
|
706
|
+
component: "GeomVline",
|
|
707
|
+
summary: "Vertical reference-line alias. Canonicalized by normalize() to a rule layer. Annotation form: set params.xintercept. Data-driven form: map aes.x (inherited plot y is dropped so the one-axis rule contract holds).",
|
|
708
|
+
defaultStat: "identity",
|
|
709
|
+
defaultPosition: "identity",
|
|
710
|
+
allowedStats: ["identity"],
|
|
711
|
+
allowedPositions: ["identity"],
|
|
712
|
+
paramsType: "VlineParams",
|
|
713
|
+
params: [
|
|
714
|
+
{
|
|
715
|
+
name: "xintercept",
|
|
716
|
+
description: "ANNOTATION FORM ONLY: draw a vertical rule at each of these fixed x positions. Mutually exclusive with mapping aes.x on this layer.",
|
|
717
|
+
typeSummary: "RuleIntercept",
|
|
718
|
+
required: false,
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
name: "alpha",
|
|
722
|
+
description: "Rule opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
723
|
+
typeSummary: "number",
|
|
724
|
+
required: false,
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
name: "linewidth",
|
|
728
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
729
|
+
typeSummary: "number",
|
|
730
|
+
required: false,
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
name: "strokePaint",
|
|
734
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
735
|
+
typeSummary: "GradientPaint",
|
|
736
|
+
required: false,
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
name: "glow",
|
|
740
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
741
|
+
typeSummary: "GlowSpec",
|
|
742
|
+
required: false,
|
|
743
|
+
},
|
|
744
|
+
],
|
|
745
|
+
aliasOf: "rule",
|
|
746
|
+
},
|
|
747
|
+
text: {
|
|
748
|
+
name: "text",
|
|
749
|
+
slug: "text",
|
|
750
|
+
component: "GeomText",
|
|
751
|
+
summary: "Text geometry: one label per data row at (x, y). No collision detection — labels draw exactly where placed. Requires x, y, and label channels.",
|
|
752
|
+
defaultStat: "identity",
|
|
753
|
+
defaultPosition: "identity",
|
|
754
|
+
allowedStats: ["identity", "unique"],
|
|
755
|
+
allowedPositions: ["identity", "nudge"],
|
|
756
|
+
paramsType: "TextParams",
|
|
757
|
+
params: [
|
|
758
|
+
{
|
|
759
|
+
name: "alpha",
|
|
760
|
+
description: "Text opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
761
|
+
typeSummary: "number",
|
|
762
|
+
required: false,
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
name: "size",
|
|
766
|
+
description: "Font size in px. Must be greater than 0. Default 11.",
|
|
767
|
+
typeSummary: "number",
|
|
768
|
+
required: false,
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
name: "anchor",
|
|
772
|
+
description: 'Horizontal text anchor relative to the (x, y) position: "start", "middle" (default), or "end".',
|
|
773
|
+
typeSummary: '"start" | "middle" | "end"',
|
|
774
|
+
required: false,
|
|
775
|
+
},
|
|
776
|
+
{
|
|
777
|
+
name: "dx",
|
|
778
|
+
description: "Horizontal offset in px applied after positioning. Default 0.",
|
|
779
|
+
typeSummary: "number",
|
|
780
|
+
required: false,
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
name: "dy",
|
|
784
|
+
description: "Vertical offset in px applied after positioning (positive = down). Default 0.",
|
|
785
|
+
typeSummary: "number",
|
|
786
|
+
required: false,
|
|
787
|
+
},
|
|
788
|
+
],
|
|
789
|
+
},
|
|
790
|
+
label: {
|
|
791
|
+
name: "label",
|
|
792
|
+
slug: "label",
|
|
793
|
+
component: "GeomLabel",
|
|
794
|
+
summary: "Label geometry: text with a rounded rectangular background box. Requires x, y, and label channels. No collision detection.",
|
|
795
|
+
defaultStat: "identity",
|
|
796
|
+
defaultPosition: "identity",
|
|
797
|
+
allowedStats: ["identity"],
|
|
798
|
+
allowedPositions: ["identity", "nudge"],
|
|
799
|
+
paramsType: "LabelParams",
|
|
800
|
+
params: [
|
|
801
|
+
{
|
|
802
|
+
name: "alpha",
|
|
803
|
+
description: "Label opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
804
|
+
typeSummary: "number",
|
|
805
|
+
required: false,
|
|
806
|
+
},
|
|
807
|
+
{
|
|
808
|
+
name: "size",
|
|
809
|
+
description: "Font size in px. Must be greater than 0. Default 11.",
|
|
810
|
+
typeSummary: "number",
|
|
811
|
+
required: false,
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
name: "anchor",
|
|
815
|
+
description: 'Horizontal text anchor relative to the (x, y) position: "start", "middle" (default), or "end".',
|
|
816
|
+
typeSummary: '"start" | "middle" | "end"',
|
|
817
|
+
required: false,
|
|
818
|
+
},
|
|
819
|
+
{
|
|
820
|
+
name: "dx",
|
|
821
|
+
description: "Horizontal offset in px applied after positioning. Default 0.",
|
|
822
|
+
typeSummary: "number",
|
|
823
|
+
required: false,
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
name: "dy",
|
|
827
|
+
description: "Vertical offset in px applied after positioning (positive = down). Default 0.",
|
|
828
|
+
typeSummary: "number",
|
|
829
|
+
required: false,
|
|
830
|
+
},
|
|
831
|
+
{
|
|
832
|
+
name: "padding",
|
|
833
|
+
description: "Uniform box padding around the text in px. Default 3.",
|
|
834
|
+
typeSummary: "number",
|
|
835
|
+
required: false,
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
name: "radius",
|
|
839
|
+
description: "Corner radius of the background box in px. Default 3.",
|
|
840
|
+
typeSummary: "number",
|
|
841
|
+
required: false,
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
name: "linewidth",
|
|
845
|
+
description: "Box outline stroke width in px. Default 0.5.",
|
|
846
|
+
typeSummary: "number",
|
|
847
|
+
required: false,
|
|
848
|
+
},
|
|
849
|
+
],
|
|
850
|
+
},
|
|
851
|
+
smooth: {
|
|
852
|
+
name: "smooth",
|
|
853
|
+
slug: "smooth",
|
|
854
|
+
component: "GeomSmooth",
|
|
855
|
+
summary: "Smooth geometry: a fitted trend line (with an optional confidence ribbon) over an x/y scatter, one fit per group. Use to reveal trends.",
|
|
856
|
+
defaultStat: "smooth",
|
|
857
|
+
defaultPosition: "identity",
|
|
858
|
+
allowedStats: ["smooth"],
|
|
859
|
+
allowedPositions: ["identity"],
|
|
860
|
+
paramsType: "SmoothParams",
|
|
861
|
+
params: [
|
|
862
|
+
{
|
|
863
|
+
name: "method",
|
|
864
|
+
description: 'Smoothing method: "lm" (least-squares line) or "loess" (local polynomial regression). Omit to infer: loess for fewer than 1000 rows, lm above (an advisory reports the choice).',
|
|
865
|
+
typeSummary: '"lm" | "loess"',
|
|
866
|
+
required: false,
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
name: "se",
|
|
870
|
+
description: "Draw the confidence-interval ribbon around the fit. Default true.",
|
|
871
|
+
typeSummary: "boolean",
|
|
872
|
+
required: false,
|
|
873
|
+
},
|
|
874
|
+
{
|
|
875
|
+
name: "level",
|
|
876
|
+
description: "Confidence level of the ribbon, strictly between 0 and 1. Default 0.95.",
|
|
877
|
+
typeSummary: "number",
|
|
878
|
+
required: false,
|
|
879
|
+
},
|
|
880
|
+
{
|
|
881
|
+
name: "span",
|
|
882
|
+
description: "LOESS ONLY: fraction of points in each local neighborhood, greater than 0 and at most 1. Default 0.75. Smaller = wigglier.",
|
|
883
|
+
typeSummary: "number",
|
|
884
|
+
required: false,
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
name: "degree",
|
|
888
|
+
description: "LOESS ONLY: degree of the local polynomial, 1 or 2. Default 2 (the R default).",
|
|
889
|
+
typeSummary: "1 | 2",
|
|
890
|
+
required: false,
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
name: "n",
|
|
894
|
+
description: "Number of evaluation points along x (an integer between 2 and 5000). Default 80.",
|
|
895
|
+
typeSummary: "number",
|
|
896
|
+
required: false,
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
name: "linewidth",
|
|
900
|
+
description: "Stroke width of the fitted line in px. Must be greater than 0. Default 1.",
|
|
901
|
+
typeSummary: "number",
|
|
902
|
+
required: false,
|
|
903
|
+
},
|
|
904
|
+
{
|
|
905
|
+
name: "alpha",
|
|
906
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
907
|
+
typeSummary: "number",
|
|
908
|
+
required: false,
|
|
909
|
+
},
|
|
910
|
+
{
|
|
911
|
+
name: "strokePaint",
|
|
912
|
+
description: "Within-mark gradient stroke paint for the fitted line (not a data scale).",
|
|
913
|
+
typeSummary: "GradientPaint",
|
|
914
|
+
required: false,
|
|
915
|
+
},
|
|
916
|
+
{
|
|
917
|
+
name: "glow",
|
|
918
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
919
|
+
typeSummary: "GlowSpec",
|
|
920
|
+
required: false,
|
|
921
|
+
},
|
|
922
|
+
],
|
|
923
|
+
},
|
|
924
|
+
quantile: {
|
|
925
|
+
name: "quantile",
|
|
926
|
+
slug: "quantile",
|
|
927
|
+
component: "GeomQuantile",
|
|
928
|
+
summary: "Quantile geometry: linear quantile regression lines (y ~ x) at one or more conditional quantiles of y, one line per quantile per group.",
|
|
929
|
+
defaultStat: "quantile",
|
|
930
|
+
defaultPosition: "identity",
|
|
931
|
+
allowedStats: ["quantile"],
|
|
932
|
+
allowedPositions: ["identity"],
|
|
933
|
+
paramsType: "QuantileParams",
|
|
934
|
+
params: [
|
|
935
|
+
{
|
|
936
|
+
name: "quantiles",
|
|
937
|
+
description: "Conditional quantiles of y to fit and draw. Each entry must be in (0, 1). Default [0.25, 0.5, 0.75].",
|
|
938
|
+
typeSummary: "Array<number>",
|
|
939
|
+
required: false,
|
|
940
|
+
},
|
|
941
|
+
{
|
|
942
|
+
name: "n",
|
|
943
|
+
description: "Number of evaluation points along x (integer 2–5000). Default 80. Linear fits need only endpoints; denser grids help nonlinear coords.",
|
|
944
|
+
typeSummary: "number",
|
|
945
|
+
required: false,
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
name: "linewidth",
|
|
949
|
+
description: "Stroke width of quantile lines in px. Must be greater than 0. Default 1.",
|
|
950
|
+
typeSummary: "number",
|
|
951
|
+
required: false,
|
|
952
|
+
},
|
|
953
|
+
{
|
|
954
|
+
name: "alpha",
|
|
955
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
956
|
+
typeSummary: "number",
|
|
957
|
+
required: false,
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
name: "strokePaint",
|
|
961
|
+
description: "Within-mark gradient stroke paint for quantile lines (not a data scale).",
|
|
962
|
+
typeSummary: "GradientPaint",
|
|
963
|
+
required: false,
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
name: "glow",
|
|
967
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
968
|
+
typeSummary: "GlowSpec",
|
|
969
|
+
required: false,
|
|
970
|
+
},
|
|
971
|
+
],
|
|
972
|
+
},
|
|
973
|
+
boxplot: {
|
|
974
|
+
name: "boxplot",
|
|
975
|
+
slug: "boxplot",
|
|
976
|
+
component: "GeomBoxplot",
|
|
977
|
+
summary: "Box-and-whisker geometry: one box per x category (per group) summarizing the y distribution — hinges at the quartiles, whiskers to the furthest points within coef × IQR, outliers drawn individually.",
|
|
978
|
+
defaultStat: "boxplot",
|
|
979
|
+
defaultPosition: "dodge",
|
|
980
|
+
allowedStats: ["boxplot"],
|
|
981
|
+
allowedPositions: ["dodge", "identity"],
|
|
982
|
+
paramsType: "BoxplotParams",
|
|
983
|
+
params: [
|
|
984
|
+
{
|
|
985
|
+
name: "width",
|
|
986
|
+
description: "Box width as a fraction of the band step. Must be greater than 0 and at most 1. Default 0.75. When omitted, width is also capped at 15% of the panel so few categories do not read as slabs.",
|
|
987
|
+
typeSummary: "number",
|
|
988
|
+
required: false,
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
name: "coef",
|
|
992
|
+
description: "Whisker length as a multiple of the IQR (values beyond it are outliers). Must be at least 0. Default 1.5.",
|
|
993
|
+
typeSummary: "number",
|
|
994
|
+
required: false,
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
name: "linewidth",
|
|
998
|
+
description: "Stroke width of the box, whiskers, and median line in px (the median draws at twice this). Must be greater than 0. Default 1.",
|
|
999
|
+
typeSummary: "number",
|
|
1000
|
+
required: false,
|
|
1001
|
+
},
|
|
1002
|
+
{
|
|
1003
|
+
name: "outlierSize",
|
|
1004
|
+
description: "Outlier point radius in px. Must be greater than 0. Default 1.5.",
|
|
1005
|
+
typeSummary: "number",
|
|
1006
|
+
required: false,
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
name: "alpha",
|
|
1010
|
+
description: "Layer opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1011
|
+
typeSummary: "number",
|
|
1012
|
+
required: false,
|
|
1013
|
+
},
|
|
1014
|
+
],
|
|
1015
|
+
},
|
|
1016
|
+
density: {
|
|
1017
|
+
name: "density",
|
|
1018
|
+
slug: "density",
|
|
1019
|
+
component: "GeomDensity",
|
|
1020
|
+
summary: "Density geometry: a smooth kernel density estimate of a continuous x variable, drawn as a filled area — a smoothed histogram alternative. One curve per group. Do NOT map aes.y — the density stat computes it.",
|
|
1021
|
+
defaultStat: "density",
|
|
1022
|
+
defaultPosition: "identity",
|
|
1023
|
+
allowedStats: ["density"],
|
|
1024
|
+
allowedPositions: ["identity"],
|
|
1025
|
+
paramsType: "DensityParams",
|
|
1026
|
+
params: [
|
|
1027
|
+
{
|
|
1028
|
+
name: "bw",
|
|
1029
|
+
description: "Kernel bandwidth in data units (must be greater than 0). Omit for R's bw.nrd0 rule-of-thumb default.",
|
|
1030
|
+
typeSummary: "number",
|
|
1031
|
+
required: false,
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
name: "adjust",
|
|
1035
|
+
description: "Bandwidth multiplier (must be greater than 0). Default 1. 0.5 = half the default bandwidth (wigglier), 2 = double (smoother).",
|
|
1036
|
+
typeSummary: "number",
|
|
1037
|
+
required: false,
|
|
1038
|
+
},
|
|
1039
|
+
{
|
|
1040
|
+
name: "n",
|
|
1041
|
+
description: "Number of grid points the density is evaluated at (an integer between 2 and 4096). Default 512 (the R default).",
|
|
1042
|
+
typeSummary: "number",
|
|
1043
|
+
required: false,
|
|
1044
|
+
},
|
|
1045
|
+
{
|
|
1046
|
+
name: "cut",
|
|
1047
|
+
description: "The grid extends cut * bandwidth beyond the data extremes (at least 0). Default 3 (the R default).",
|
|
1048
|
+
typeSummary: "number",
|
|
1049
|
+
required: false,
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
name: "alpha",
|
|
1053
|
+
description: "Area fill opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1054
|
+
typeSummary: "number",
|
|
1055
|
+
required: false,
|
|
1056
|
+
},
|
|
1057
|
+
{
|
|
1058
|
+
name: "fillPaint",
|
|
1059
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
1060
|
+
typeSummary: "GradientPaint",
|
|
1061
|
+
required: false,
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
name: "glow",
|
|
1065
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1066
|
+
typeSummary: "GlowSpec",
|
|
1067
|
+
required: false,
|
|
1068
|
+
},
|
|
1069
|
+
],
|
|
1070
|
+
},
|
|
1071
|
+
errorbar: {
|
|
1072
|
+
name: "errorbar",
|
|
1073
|
+
slug: "errorbar",
|
|
1074
|
+
component: "GeomErrorbar",
|
|
1075
|
+
summary: "Errorbar geometry: a vertical range with caps at ymin and ymax, one per data row (identity stat) or per x group (summary stat).",
|
|
1076
|
+
defaultStat: "identity",
|
|
1077
|
+
defaultPosition: "identity",
|
|
1078
|
+
allowedStats: ["identity", "unique", "summary", "summary_bin"],
|
|
1079
|
+
allowedPositions: ["identity"],
|
|
1080
|
+
paramsType: "ErrorbarParams",
|
|
1081
|
+
params: [
|
|
1082
|
+
{
|
|
1083
|
+
name: "width",
|
|
1084
|
+
description: "Cap width as a fraction of the band step. Must be greater than 0 and at most 1. Default 0.9.",
|
|
1085
|
+
typeSummary: "number",
|
|
1086
|
+
required: false,
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
name: "linewidth",
|
|
1090
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
1091
|
+
typeSummary: "number",
|
|
1092
|
+
required: false,
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
name: "alpha",
|
|
1096
|
+
description: "Errorbar opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1097
|
+
typeSummary: "number",
|
|
1098
|
+
required: false,
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
name: "fun",
|
|
1102
|
+
description: 'STAT SUMMARY ONLY: the center summary of y per x group: "mean" (default), "median", or "sum". With "mean" and no funMin/funMax, the bounds default to mean ± standard error.',
|
|
1103
|
+
typeSummary: '"mean" | "median" | "sum"',
|
|
1104
|
+
required: false,
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
name: "funMin",
|
|
1108
|
+
description: "STAT SUMMARY ONLY: summary function for the lower bound (ymin). Overrides the mean_se default.",
|
|
1109
|
+
typeSummary: "SummaryFun",
|
|
1110
|
+
required: false,
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
name: "funMax",
|
|
1114
|
+
description: "STAT SUMMARY / SUMMARY_BIN: summary function for the upper bound (ymax). Overrides the mean_se default.",
|
|
1115
|
+
typeSummary: "SummaryFun",
|
|
1116
|
+
required: false,
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
name: "bins",
|
|
1120
|
+
description: "STAT SUMMARY_BIN ONLY: number of bins (integer ≥ 1). Default 30 — advisory. Overridden by binwidth.",
|
|
1121
|
+
typeSummary: "number",
|
|
1122
|
+
required: false,
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
name: "binwidth",
|
|
1126
|
+
description: "STAT SUMMARY_BIN ONLY: bin width in data units (must be greater than 0). Takes precedence over bins.",
|
|
1127
|
+
typeSummary: "number",
|
|
1128
|
+
required: false,
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
name: "boundary",
|
|
1132
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin EDGE with this x value. Mutually exclusive with center.",
|
|
1133
|
+
typeSummary: "number",
|
|
1134
|
+
required: false,
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
name: "center",
|
|
1138
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
1139
|
+
typeSummary: "number",
|
|
1140
|
+
required: false,
|
|
1141
|
+
},
|
|
1142
|
+
{
|
|
1143
|
+
name: "closed",
|
|
1144
|
+
description: 'STAT SUMMARY_BIN ONLY: which edge of each bin is inclusive: "right" (default) or "left".',
|
|
1145
|
+
typeSummary: '"right" | "left"',
|
|
1146
|
+
required: false,
|
|
1147
|
+
},
|
|
1148
|
+
],
|
|
1149
|
+
},
|
|
1150
|
+
linerange: {
|
|
1151
|
+
name: "linerange",
|
|
1152
|
+
slug: "linerange",
|
|
1153
|
+
component: "GeomLinerange",
|
|
1154
|
+
summary: "Linerange geometry: a vertical stem from ymin to ymax without end caps.",
|
|
1155
|
+
defaultStat: "identity",
|
|
1156
|
+
defaultPosition: "identity",
|
|
1157
|
+
allowedStats: ["identity", "summary"],
|
|
1158
|
+
allowedPositions: ["identity"],
|
|
1159
|
+
paramsType: "LinerangeParams",
|
|
1160
|
+
params: [
|
|
1161
|
+
{
|
|
1162
|
+
name: "width",
|
|
1163
|
+
description: "Cap width as a fraction of the band step. Must be greater than 0 and at most 1. Default 0.9.",
|
|
1164
|
+
typeSummary: "number",
|
|
1165
|
+
required: false,
|
|
1166
|
+
},
|
|
1167
|
+
{
|
|
1168
|
+
name: "linewidth",
|
|
1169
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
1170
|
+
typeSummary: "number",
|
|
1171
|
+
required: false,
|
|
1172
|
+
},
|
|
1173
|
+
{
|
|
1174
|
+
name: "alpha",
|
|
1175
|
+
description: "Errorbar opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1176
|
+
typeSummary: "number",
|
|
1177
|
+
required: false,
|
|
1178
|
+
},
|
|
1179
|
+
{
|
|
1180
|
+
name: "fun",
|
|
1181
|
+
description: 'STAT SUMMARY ONLY: the center summary of y per x group: "mean" (default), "median", or "sum". With "mean" and no funMin/funMax, the bounds default to mean ± standard error.',
|
|
1182
|
+
typeSummary: '"mean" | "median" | "sum"',
|
|
1183
|
+
required: false,
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
name: "funMin",
|
|
1187
|
+
description: "STAT SUMMARY ONLY: summary function for the lower bound (ymin). Overrides the mean_se default.",
|
|
1188
|
+
typeSummary: "SummaryFun",
|
|
1189
|
+
required: false,
|
|
1190
|
+
},
|
|
1191
|
+
{
|
|
1192
|
+
name: "funMax",
|
|
1193
|
+
description: "STAT SUMMARY / SUMMARY_BIN: summary function for the upper bound (ymax). Overrides the mean_se default.",
|
|
1194
|
+
typeSummary: "SummaryFun",
|
|
1195
|
+
required: false,
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
name: "bins",
|
|
1199
|
+
description: "STAT SUMMARY_BIN ONLY: number of bins (integer ≥ 1). Default 30 — advisory. Overridden by binwidth.",
|
|
1200
|
+
typeSummary: "number",
|
|
1201
|
+
required: false,
|
|
1202
|
+
},
|
|
1203
|
+
{
|
|
1204
|
+
name: "binwidth",
|
|
1205
|
+
description: "STAT SUMMARY_BIN ONLY: bin width in data units (must be greater than 0). Takes precedence over bins.",
|
|
1206
|
+
typeSummary: "number",
|
|
1207
|
+
required: false,
|
|
1208
|
+
},
|
|
1209
|
+
{
|
|
1210
|
+
name: "boundary",
|
|
1211
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin EDGE with this x value. Mutually exclusive with center.",
|
|
1212
|
+
typeSummary: "number",
|
|
1213
|
+
required: false,
|
|
1214
|
+
},
|
|
1215
|
+
{
|
|
1216
|
+
name: "center",
|
|
1217
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
1218
|
+
typeSummary: "number",
|
|
1219
|
+
required: false,
|
|
1220
|
+
},
|
|
1221
|
+
{
|
|
1222
|
+
name: "closed",
|
|
1223
|
+
description: 'STAT SUMMARY_BIN ONLY: which edge of each bin is inclusive: "right" (default) or "left".',
|
|
1224
|
+
typeSummary: '"right" | "left"',
|
|
1225
|
+
required: false,
|
|
1226
|
+
},
|
|
1227
|
+
],
|
|
1228
|
+
},
|
|
1229
|
+
pointrange: {
|
|
1230
|
+
name: "pointrange",
|
|
1231
|
+
slug: "pointrange",
|
|
1232
|
+
component: "GeomPointrange",
|
|
1233
|
+
summary: "Pointrange geometry: vertical stem from ymin to ymax plus a point at (x, y).",
|
|
1234
|
+
defaultStat: "identity",
|
|
1235
|
+
defaultPosition: "identity",
|
|
1236
|
+
allowedStats: ["identity", "summary"],
|
|
1237
|
+
allowedPositions: ["identity"],
|
|
1238
|
+
paramsType: "PointrangeParams",
|
|
1239
|
+
params: [
|
|
1240
|
+
{
|
|
1241
|
+
name: "linewidth",
|
|
1242
|
+
description: "Stem stroke width in px. Must be greater than 0. Default 1.",
|
|
1243
|
+
typeSummary: "number",
|
|
1244
|
+
required: false,
|
|
1245
|
+
},
|
|
1246
|
+
{
|
|
1247
|
+
name: "alpha",
|
|
1248
|
+
description: "Opacity for stem and point. Default 1.",
|
|
1249
|
+
typeSummary: "number",
|
|
1250
|
+
required: false,
|
|
1251
|
+
},
|
|
1252
|
+
{
|
|
1253
|
+
name: "size",
|
|
1254
|
+
description: "Mid-point radius in px. Default 2.5.",
|
|
1255
|
+
typeSummary: "number",
|
|
1256
|
+
required: false,
|
|
1257
|
+
},
|
|
1258
|
+
{
|
|
1259
|
+
name: "shape",
|
|
1260
|
+
description: 'Mid-point shape. Default "circle".',
|
|
1261
|
+
typeSummary: '"circle" | "triangle" | "square" | "diamond" | "plus" | "cross" | "circle-open"',
|
|
1262
|
+
required: false,
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
name: "fun",
|
|
1266
|
+
description: 'STAT SUMMARY ONLY: center summary of y per x group. Default "mean" (mean_se when funMin/funMax omitted).',
|
|
1267
|
+
typeSummary: '"mean" | "median" | "sum"',
|
|
1268
|
+
required: false,
|
|
1269
|
+
},
|
|
1270
|
+
{
|
|
1271
|
+
name: "funMin",
|
|
1272
|
+
description: "STAT SUMMARY ONLY: summary function for the lower bound (ymin). Overrides the mean_se default.",
|
|
1273
|
+
typeSummary: "SummaryFun",
|
|
1274
|
+
required: false,
|
|
1275
|
+
},
|
|
1276
|
+
{
|
|
1277
|
+
name: "funMax",
|
|
1278
|
+
description: "STAT SUMMARY ONLY: summary function for the upper bound (ymax). Overrides the mean_se default.",
|
|
1279
|
+
typeSummary: "SummaryFun",
|
|
1280
|
+
required: false,
|
|
1281
|
+
},
|
|
1282
|
+
],
|
|
1283
|
+
},
|
|
1284
|
+
crossbar: {
|
|
1285
|
+
name: "crossbar",
|
|
1286
|
+
slug: "crossbar",
|
|
1287
|
+
component: "GeomCrossbar",
|
|
1288
|
+
summary: "Crossbar geometry: a vertical interval box from ymin to ymax with a mid horizontal line at y.",
|
|
1289
|
+
defaultStat: "identity",
|
|
1290
|
+
defaultPosition: "identity",
|
|
1291
|
+
allowedStats: ["identity", "summary"],
|
|
1292
|
+
allowedPositions: ["identity"],
|
|
1293
|
+
paramsType: "CrossbarParams",
|
|
1294
|
+
params: [
|
|
1295
|
+
{
|
|
1296
|
+
name: "width",
|
|
1297
|
+
description: "Box width: band-step fraction (band x) or fraction of continuous resolution (same rule as errorbar caps). Default 0.9.",
|
|
1298
|
+
typeSummary: "number",
|
|
1299
|
+
required: false,
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
name: "fatten",
|
|
1303
|
+
description: "Multiplier for the mid-line linewidth relative to params.linewidth / aes.linewidth. Default 2.5.",
|
|
1304
|
+
typeSummary: "number",
|
|
1305
|
+
required: false,
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
name: "linewidth",
|
|
1309
|
+
description: "Outline and base mid-line stroke width in px. Default 1.",
|
|
1310
|
+
typeSummary: "number",
|
|
1311
|
+
required: false,
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
name: "alpha",
|
|
1315
|
+
description: "Box and mid-line opacity. Default 1.",
|
|
1316
|
+
typeSummary: "number",
|
|
1317
|
+
required: false,
|
|
1318
|
+
},
|
|
1319
|
+
{
|
|
1320
|
+
name: "fun",
|
|
1321
|
+
description: 'STAT SUMMARY ONLY: center summary. Default "mean".',
|
|
1322
|
+
typeSummary: '"mean" | "median" | "sum"',
|
|
1323
|
+
required: false,
|
|
1324
|
+
},
|
|
1325
|
+
{
|
|
1326
|
+
name: "funMin",
|
|
1327
|
+
description: "STAT SUMMARY ONLY: summary function for the lower bound (ymin). Overrides the mean_se default.",
|
|
1328
|
+
typeSummary: "SummaryFun",
|
|
1329
|
+
required: false,
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
name: "funMax",
|
|
1333
|
+
description: "STAT SUMMARY ONLY: summary function for the upper bound (ymax). Overrides the mean_se default.",
|
|
1334
|
+
typeSummary: "SummaryFun",
|
|
1335
|
+
required: false,
|
|
1336
|
+
},
|
|
1337
|
+
],
|
|
1338
|
+
},
|
|
1339
|
+
rect: {
|
|
1340
|
+
name: "rect",
|
|
1341
|
+
slug: "rect",
|
|
1342
|
+
component: "GeomRect",
|
|
1343
|
+
summary: "Rectangle geometry: one rectangle per data row from mapped xmin/xmax/ymin/ymax edges. Use for arbitrary shaded regions and time bands.",
|
|
1344
|
+
defaultStat: "identity",
|
|
1345
|
+
defaultPosition: "identity",
|
|
1346
|
+
allowedStats: ["identity", "unique"],
|
|
1347
|
+
allowedPositions: ["identity"],
|
|
1348
|
+
paramsType: "RectParams",
|
|
1349
|
+
params: [
|
|
1350
|
+
{
|
|
1351
|
+
name: "linewidth",
|
|
1352
|
+
description: "Outline stroke width in px when color is set. Must be greater than 0.",
|
|
1353
|
+
typeSummary: "number",
|
|
1354
|
+
required: false,
|
|
1355
|
+
},
|
|
1356
|
+
{
|
|
1357
|
+
name: "alpha",
|
|
1358
|
+
description: "Rectangle opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1359
|
+
typeSummary: "number",
|
|
1360
|
+
required: false,
|
|
1361
|
+
},
|
|
1362
|
+
{
|
|
1363
|
+
name: "fillPaint",
|
|
1364
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
1365
|
+
typeSummary: "GradientPaint",
|
|
1366
|
+
required: false,
|
|
1367
|
+
},
|
|
1368
|
+
{
|
|
1369
|
+
name: "strokePaint",
|
|
1370
|
+
description: "Within-mark gradient outline paint (not a data scale). Requires a solid fallback.",
|
|
1371
|
+
typeSummary: "GradientPaint",
|
|
1372
|
+
required: false,
|
|
1373
|
+
},
|
|
1374
|
+
{
|
|
1375
|
+
name: "glow",
|
|
1376
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1377
|
+
typeSummary: "GlowSpec",
|
|
1378
|
+
required: false,
|
|
1379
|
+
},
|
|
1380
|
+
],
|
|
1381
|
+
},
|
|
1382
|
+
tile: {
|
|
1383
|
+
name: "tile",
|
|
1384
|
+
slug: "tile",
|
|
1385
|
+
component: "GeomTile",
|
|
1386
|
+
summary: "Tile geometry: center-sized cells at (x, y) with optional width/height. Use for heatmaps and gridded categorical cells; supports stroke outlines.",
|
|
1387
|
+
defaultStat: "identity",
|
|
1388
|
+
defaultPosition: "identity",
|
|
1389
|
+
allowedStats: ["identity"],
|
|
1390
|
+
allowedPositions: ["identity"],
|
|
1391
|
+
paramsType: "TileParams",
|
|
1392
|
+
params: [
|
|
1393
|
+
{
|
|
1394
|
+
name: "width",
|
|
1395
|
+
description: "Constant tile width in data units after position transform (band axes: fraction of the band step). Default: resolution of unique x centers (continuous) or 1 (band).",
|
|
1396
|
+
typeSummary: "number",
|
|
1397
|
+
required: false,
|
|
1398
|
+
},
|
|
1399
|
+
{
|
|
1400
|
+
name: "height",
|
|
1401
|
+
description: "Constant tile height in data units after position transform (band axes: fraction of the band step). Default: resolution of unique y centers (continuous) or 1 (band).",
|
|
1402
|
+
typeSummary: "number",
|
|
1403
|
+
required: false,
|
|
1404
|
+
},
|
|
1405
|
+
{
|
|
1406
|
+
name: "linewidth",
|
|
1407
|
+
description: "Outline stroke width in px when color is set. Must be greater than 0.",
|
|
1408
|
+
typeSummary: "number",
|
|
1409
|
+
required: false,
|
|
1410
|
+
},
|
|
1411
|
+
{
|
|
1412
|
+
name: "alpha",
|
|
1413
|
+
description: "Tile opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1414
|
+
typeSummary: "number",
|
|
1415
|
+
required: false,
|
|
1416
|
+
},
|
|
1417
|
+
{
|
|
1418
|
+
name: "fillPaint",
|
|
1419
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
1420
|
+
typeSummary: "GradientPaint",
|
|
1421
|
+
required: false,
|
|
1422
|
+
},
|
|
1423
|
+
{
|
|
1424
|
+
name: "strokePaint",
|
|
1425
|
+
description: "Within-mark gradient outline paint (not a data scale). Requires a solid fallback.",
|
|
1426
|
+
typeSummary: "GradientPaint",
|
|
1427
|
+
required: false,
|
|
1428
|
+
},
|
|
1429
|
+
{
|
|
1430
|
+
name: "glow",
|
|
1431
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1432
|
+
typeSummary: "GlowSpec",
|
|
1433
|
+
required: false,
|
|
1434
|
+
},
|
|
1435
|
+
],
|
|
1436
|
+
},
|
|
1437
|
+
raster: {
|
|
1438
|
+
name: "raster",
|
|
1439
|
+
slug: "raster",
|
|
1440
|
+
component: "GeomRaster",
|
|
1441
|
+
summary: "Raster geometry: equal-cell grid at (x, y) with fill; optimized dense heatmaps without per-cell strokes. Irregular spacing warns and suggests geom tile.",
|
|
1442
|
+
defaultStat: "identity",
|
|
1443
|
+
defaultPosition: "identity",
|
|
1444
|
+
allowedStats: ["identity"],
|
|
1445
|
+
allowedPositions: ["identity"],
|
|
1446
|
+
paramsType: "RasterParams",
|
|
1447
|
+
params: [
|
|
1448
|
+
{
|
|
1449
|
+
name: "alpha",
|
|
1450
|
+
description: "Raster opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1451
|
+
typeSummary: "number",
|
|
1452
|
+
required: false,
|
|
1453
|
+
},
|
|
1454
|
+
{
|
|
1455
|
+
name: "hjust",
|
|
1456
|
+
description: "Horizontal justification of each cell over its x center (0–1). Default 0.5.",
|
|
1457
|
+
typeSummary: "number",
|
|
1458
|
+
required: false,
|
|
1459
|
+
},
|
|
1460
|
+
{
|
|
1461
|
+
name: "vjust",
|
|
1462
|
+
description: "Vertical justification of each cell over its y center (0–1). Default 0.5.",
|
|
1463
|
+
typeSummary: "number",
|
|
1464
|
+
required: false,
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
name: "interpolate",
|
|
1468
|
+
description: "Interpolation between cells. Only false (nearest / no interpolation) is supported.",
|
|
1469
|
+
typeSummary: "boolean",
|
|
1470
|
+
required: false,
|
|
1471
|
+
},
|
|
1472
|
+
],
|
|
1473
|
+
},
|
|
1474
|
+
ribbon: {
|
|
1475
|
+
name: "ribbon",
|
|
1476
|
+
slug: "ribbon",
|
|
1477
|
+
component: "GeomRibbon",
|
|
1478
|
+
summary: "Ribbon geometry: a filled interval between two varying boundaries along a running coordinate. Map x+ymin+ymax (x orientation) or y+xmin+xmax (y orientation). Not a zero-baseline area.",
|
|
1479
|
+
defaultStat: "identity",
|
|
1480
|
+
defaultPosition: "identity",
|
|
1481
|
+
allowedStats: ["identity", "unique"],
|
|
1482
|
+
allowedPositions: ["identity"],
|
|
1483
|
+
paramsType: "RibbonParams",
|
|
1484
|
+
params: [
|
|
1485
|
+
{
|
|
1486
|
+
name: "alpha",
|
|
1487
|
+
description: "Ribbon fill opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1488
|
+
typeSummary: "number",
|
|
1489
|
+
required: false,
|
|
1490
|
+
},
|
|
1491
|
+
{
|
|
1492
|
+
name: "linewidth",
|
|
1493
|
+
description: "Outline stroke width in px when an outline is drawn. Must be greater than 0. Default 1.",
|
|
1494
|
+
typeSummary: "number",
|
|
1495
|
+
required: false,
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
name: "outline",
|
|
1499
|
+
description: 'Which edges receive an outline stroke: "both" (default — upper and lower), "upper", "lower", or "full" (closed outline of the band). Strokes appear when aes.color / a color constant is set, or when strokePaint is set.',
|
|
1500
|
+
typeSummary: '"both" | "upper" | "lower" | "full"',
|
|
1501
|
+
required: false,
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
name: "orientation",
|
|
1505
|
+
description: 'Running-coordinate orientation: "x" (map x + ymin + ymax) or "y" (map y + xmin + xmax). When omitted, inferred from the complete channel contract; set explicitly if both contracts are mapped.',
|
|
1506
|
+
typeSummary: '"x" | "y"',
|
|
1507
|
+
required: false,
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
name: "lineend",
|
|
1511
|
+
description: 'SVG stroke-linecap for outlines. Default "butt".',
|
|
1512
|
+
typeSummary: '"butt" | "round" | "square"',
|
|
1513
|
+
required: false,
|
|
1514
|
+
},
|
|
1515
|
+
{
|
|
1516
|
+
name: "linejoin",
|
|
1517
|
+
description: 'SVG stroke-linejoin for outlines. Default "round".',
|
|
1518
|
+
typeSummary: '"miter" | "round" | "bevel"',
|
|
1519
|
+
required: false,
|
|
1520
|
+
},
|
|
1521
|
+
{
|
|
1522
|
+
name: "fillPaint",
|
|
1523
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
1524
|
+
typeSummary: "GradientPaint",
|
|
1525
|
+
required: false,
|
|
1526
|
+
},
|
|
1527
|
+
{
|
|
1528
|
+
name: "strokePaint",
|
|
1529
|
+
description: "Within-mark gradient outline paint (not a data scale). Requires a solid fallback.",
|
|
1530
|
+
typeSummary: "GradientPaint",
|
|
1531
|
+
required: false,
|
|
1532
|
+
},
|
|
1533
|
+
{
|
|
1534
|
+
name: "glow",
|
|
1535
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1536
|
+
typeSummary: "GlowSpec",
|
|
1537
|
+
required: false,
|
|
1538
|
+
},
|
|
1539
|
+
],
|
|
1540
|
+
},
|
|
1541
|
+
segment: {
|
|
1542
|
+
name: "segment",
|
|
1543
|
+
slug: "segment",
|
|
1544
|
+
component: "GeomSegment",
|
|
1545
|
+
summary: "Segment geometry: one finite line per data row from (x, y) to (xend, yend). Unlike rule, endpoints are data-mapped and do not span the panel.",
|
|
1546
|
+
defaultStat: "identity",
|
|
1547
|
+
defaultPosition: "identity",
|
|
1548
|
+
allowedStats: ["identity", "unique"],
|
|
1549
|
+
allowedPositions: ["identity"],
|
|
1550
|
+
paramsType: "SegmentParams",
|
|
1551
|
+
params: [
|
|
1552
|
+
{
|
|
1553
|
+
name: "alpha",
|
|
1554
|
+
description: "Segment opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1555
|
+
typeSummary: "number",
|
|
1556
|
+
required: false,
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
name: "linewidth",
|
|
1560
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
1561
|
+
typeSummary: "number",
|
|
1562
|
+
required: false,
|
|
1563
|
+
},
|
|
1564
|
+
{
|
|
1565
|
+
name: "lineend",
|
|
1566
|
+
description: 'SVG stroke-linecap for segment ends. Default "butt".',
|
|
1567
|
+
typeSummary: '"butt" | "round" | "square"',
|
|
1568
|
+
required: false,
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
name: "strokePaint",
|
|
1572
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
1573
|
+
typeSummary: "GradientPaint",
|
|
1574
|
+
required: false,
|
|
1575
|
+
},
|
|
1576
|
+
{
|
|
1577
|
+
name: "glow",
|
|
1578
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1579
|
+
typeSummary: "GlowSpec",
|
|
1580
|
+
required: false,
|
|
1581
|
+
},
|
|
1582
|
+
],
|
|
1583
|
+
},
|
|
1584
|
+
count: {
|
|
1585
|
+
name: "count",
|
|
1586
|
+
slug: "count",
|
|
1587
|
+
component: "GeomCount",
|
|
1588
|
+
summary: "Count geometry: point marks at unique (x, y) with size scaled by after_stat n (stat sum). Use for overplotting density on discrete or rounded coordinates.",
|
|
1589
|
+
defaultStat: "sum",
|
|
1590
|
+
defaultPosition: "identity",
|
|
1591
|
+
allowedStats: ["sum"],
|
|
1592
|
+
allowedPositions: ["identity", "jitter", "nudge"],
|
|
1593
|
+
paramsType: "PointParams",
|
|
1594
|
+
params: [
|
|
1595
|
+
{
|
|
1596
|
+
name: "alpha",
|
|
1597
|
+
description: "Point opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1598
|
+
typeSummary: "number",
|
|
1599
|
+
required: false,
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
name: "size",
|
|
1603
|
+
description: "Point radius in px. Must be greater than 0. Default 2.5.",
|
|
1604
|
+
typeSummary: "number",
|
|
1605
|
+
required: false,
|
|
1606
|
+
},
|
|
1607
|
+
{
|
|
1608
|
+
name: "shape",
|
|
1609
|
+
description: 'Point shape. One of "circle", "triangle", "square", "diamond", "plus", "cross", "circle-open". Default "circle".',
|
|
1610
|
+
typeSummary: '"circle" | "triangle" | "square" | "diamond" | "plus" | "cross" | "circle-open"',
|
|
1611
|
+
required: false,
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
name: "bins",
|
|
1615
|
+
description: "STAT SUMMARY_BIN ONLY: number of bins (integer ≥ 1). Default 30 — advisory. Overridden by binwidth.",
|
|
1616
|
+
typeSummary: "number",
|
|
1617
|
+
required: false,
|
|
1618
|
+
},
|
|
1619
|
+
{
|
|
1620
|
+
name: "binwidth",
|
|
1621
|
+
description: "STAT SUMMARY_BIN ONLY: bin width in data units (must be greater than 0). Takes precedence over bins.",
|
|
1622
|
+
typeSummary: "number",
|
|
1623
|
+
required: false,
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
name: "boundary",
|
|
1627
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin EDGE with this x value. Mutually exclusive with center.",
|
|
1628
|
+
typeSummary: "number",
|
|
1629
|
+
required: false,
|
|
1630
|
+
},
|
|
1631
|
+
{
|
|
1632
|
+
name: "center",
|
|
1633
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
1634
|
+
typeSummary: "number",
|
|
1635
|
+
required: false,
|
|
1636
|
+
},
|
|
1637
|
+
{
|
|
1638
|
+
name: "closed",
|
|
1639
|
+
description: 'STAT SUMMARY_BIN ONLY: which edge of each bin is inclusive: "right" (default) or "left".',
|
|
1640
|
+
typeSummary: '"right" | "left"',
|
|
1641
|
+
required: false,
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
name: "window",
|
|
1645
|
+
description: 'STAT SUMMARY_ROLLING ONLY: centered rolling-window width in x data units (must be greater than 0). Required when stat is "summary_rolling".',
|
|
1646
|
+
typeSummary: "number",
|
|
1647
|
+
required: false,
|
|
1648
|
+
},
|
|
1649
|
+
{
|
|
1650
|
+
name: "fun",
|
|
1651
|
+
description: 'SUMMARY_BIN / SUMMARY_ROLLING center fun (mean/median/sum;) or MANUAL named transform (first|last|mean|median|min|max|sum;). Required when stat is "manual".',
|
|
1652
|
+
typeSummary: '"first" | "last" | "mean" | "median" | "min" | "max" | "sum"',
|
|
1653
|
+
required: false,
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
name: "funMin",
|
|
1657
|
+
description: "STAT SUMMARY_BIN ONLY: lower bound summary (ymin).",
|
|
1658
|
+
typeSummary: "SummaryFun",
|
|
1659
|
+
required: false,
|
|
1660
|
+
},
|
|
1661
|
+
{
|
|
1662
|
+
name: "funMax",
|
|
1663
|
+
description: "STAT SUMMARY_BIN ONLY: upper bound summary (ymax).",
|
|
1664
|
+
typeSummary: "SummaryFun",
|
|
1665
|
+
required: false,
|
|
1666
|
+
},
|
|
1667
|
+
],
|
|
1668
|
+
},
|
|
1669
|
+
violin: {
|
|
1670
|
+
name: "violin",
|
|
1671
|
+
slug: "violin",
|
|
1672
|
+
component: "GeomViolin",
|
|
1673
|
+
summary: "Violin geometry: mirrored kernel density of continuous y at each discrete x (stat ydensity). One polygon per x×group. Default position dodge.",
|
|
1674
|
+
defaultStat: "ydensity",
|
|
1675
|
+
defaultPosition: "dodge",
|
|
1676
|
+
allowedStats: ["ydensity"],
|
|
1677
|
+
allowedPositions: ["dodge", "identity"],
|
|
1678
|
+
paramsType: "ViolinParams",
|
|
1679
|
+
params: [
|
|
1680
|
+
{
|
|
1681
|
+
name: "bw",
|
|
1682
|
+
description: "Kernel bandwidth in data units (must be greater than 0). Omit for R's bw.nrd0 rule-of-thumb default.",
|
|
1683
|
+
typeSummary: "number",
|
|
1684
|
+
required: false,
|
|
1685
|
+
},
|
|
1686
|
+
{
|
|
1687
|
+
name: "adjust",
|
|
1688
|
+
description: "Bandwidth multiplier (must be greater than 0). Default 1.",
|
|
1689
|
+
typeSummary: "number",
|
|
1690
|
+
required: false,
|
|
1691
|
+
},
|
|
1692
|
+
{
|
|
1693
|
+
name: "n",
|
|
1694
|
+
description: "Number of density grid points (2–4096). Default 512.",
|
|
1695
|
+
typeSummary: "number",
|
|
1696
|
+
required: false,
|
|
1697
|
+
},
|
|
1698
|
+
{
|
|
1699
|
+
name: "trim",
|
|
1700
|
+
description: "When true (default), trim the density to the data range; when false, extend cut·bw tails like density().",
|
|
1701
|
+
typeSummary: "boolean",
|
|
1702
|
+
required: false,
|
|
1703
|
+
},
|
|
1704
|
+
{
|
|
1705
|
+
name: "scale",
|
|
1706
|
+
description: 'Relative violin max-width scaling: "area" (default), "count", or "width" (equal max width).',
|
|
1707
|
+
typeSummary: '"area" | "count" | "width"',
|
|
1708
|
+
required: false,
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
name: "width",
|
|
1712
|
+
description: "Max violin width as a fraction of the discrete x band (like boxplot). Default 0.75.",
|
|
1713
|
+
typeSummary: "number",
|
|
1714
|
+
required: false,
|
|
1715
|
+
},
|
|
1716
|
+
{
|
|
1717
|
+
name: "alpha",
|
|
1718
|
+
description: "Fill opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1719
|
+
typeSummary: "number",
|
|
1720
|
+
required: false,
|
|
1721
|
+
},
|
|
1722
|
+
{
|
|
1723
|
+
name: "linewidth",
|
|
1724
|
+
description: "Outline stroke width in px. Must be greater than 0. Default 0.5.",
|
|
1725
|
+
typeSummary: "number",
|
|
1726
|
+
required: false,
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
1729
|
+
name: "fillPaint",
|
|
1730
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
1731
|
+
typeSummary: "GradientPaint",
|
|
1732
|
+
required: false,
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
name: "strokePaint",
|
|
1736
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
1737
|
+
typeSummary: "GradientPaint",
|
|
1738
|
+
required: false,
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
name: "glow",
|
|
1742
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1743
|
+
typeSummary: "GlowSpec",
|
|
1744
|
+
required: false,
|
|
1745
|
+
},
|
|
1746
|
+
],
|
|
1747
|
+
},
|
|
1748
|
+
function: {
|
|
1749
|
+
name: "function",
|
|
1750
|
+
slug: "function",
|
|
1751
|
+
component: "GeomFunction",
|
|
1752
|
+
summary: "Function geometry: evaluate a named portable function y = f(x) on a grid and draw a path. Requires params.fun; domain from params.xlim, mapped x, or peer layers.",
|
|
1753
|
+
defaultStat: "function",
|
|
1754
|
+
defaultPosition: "identity",
|
|
1755
|
+
allowedStats: ["function"],
|
|
1756
|
+
allowedPositions: ["identity"],
|
|
1757
|
+
paramsType: "FunctionParams",
|
|
1758
|
+
params: [
|
|
1759
|
+
{
|
|
1760
|
+
name: "fun",
|
|
1761
|
+
description: "Required named function from the portable registry.",
|
|
1762
|
+
typeSummary: "FunctionRegistryName",
|
|
1763
|
+
required: true,
|
|
1764
|
+
},
|
|
1765
|
+
{
|
|
1766
|
+
name: "n",
|
|
1767
|
+
description: "Number of evaluation grid points (2–10000). Default 101.",
|
|
1768
|
+
typeSummary: "number",
|
|
1769
|
+
required: false,
|
|
1770
|
+
},
|
|
1771
|
+
{
|
|
1772
|
+
name: "xlim",
|
|
1773
|
+
description: "Evaluation domain [min, max] (min < max). When omitted, uses continuous aes.x extent or peer-layer x domain.",
|
|
1774
|
+
typeSummary: "Array<number>",
|
|
1775
|
+
required: false,
|
|
1776
|
+
},
|
|
1777
|
+
{
|
|
1778
|
+
name: "args",
|
|
1779
|
+
description: "Optional named arguments for the registry function (e.g. mean and sd for dnorm). Keys and values must be portable JSON.",
|
|
1780
|
+
typeSummary: "FunctionArgs",
|
|
1781
|
+
required: false,
|
|
1782
|
+
},
|
|
1783
|
+
{
|
|
1784
|
+
name: "alpha",
|
|
1785
|
+
description: "Path opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1786
|
+
typeSummary: "number",
|
|
1787
|
+
required: false,
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
name: "linewidth",
|
|
1791
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.5.",
|
|
1792
|
+
typeSummary: "number",
|
|
1793
|
+
required: false,
|
|
1794
|
+
},
|
|
1795
|
+
{
|
|
1796
|
+
name: "strokePaint",
|
|
1797
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
1798
|
+
typeSummary: "GradientPaint",
|
|
1799
|
+
required: false,
|
|
1800
|
+
},
|
|
1801
|
+
{
|
|
1802
|
+
name: "glow",
|
|
1803
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1804
|
+
typeSummary: "GlowSpec",
|
|
1805
|
+
required: false,
|
|
1806
|
+
},
|
|
1807
|
+
],
|
|
1808
|
+
},
|
|
1809
|
+
polygon: {
|
|
1810
|
+
name: "polygon",
|
|
1811
|
+
slug: "polygon",
|
|
1812
|
+
component: "GeomPolygon",
|
|
1813
|
+
summary: "Polygon geometry: closed filled paths from (x, y) vertices in data/row order within each group. Groups form separate polygons. No x-sort (unlike line/area). Holes/subgroup omitted in v1.",
|
|
1814
|
+
defaultStat: "identity",
|
|
1815
|
+
defaultPosition: "identity",
|
|
1816
|
+
allowedStats: ["identity"],
|
|
1817
|
+
allowedPositions: ["identity"],
|
|
1818
|
+
paramsType: "PolygonParams",
|
|
1819
|
+
params: [
|
|
1820
|
+
{
|
|
1821
|
+
name: "alpha",
|
|
1822
|
+
description: "Polygon fill/stroke opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1823
|
+
typeSummary: "number",
|
|
1824
|
+
required: false,
|
|
1825
|
+
},
|
|
1826
|
+
{
|
|
1827
|
+
name: "linewidth",
|
|
1828
|
+
description: "Outline stroke width in px. Must be greater than 0. Default matches line (1.5).",
|
|
1829
|
+
typeSummary: "number",
|
|
1830
|
+
required: false,
|
|
1831
|
+
},
|
|
1832
|
+
{
|
|
1833
|
+
name: "fillPaint",
|
|
1834
|
+
description: "Within-mark gradient fill paint (not a data scale). Requires a solid fallback.",
|
|
1835
|
+
typeSummary: "GradientPaint",
|
|
1836
|
+
required: false,
|
|
1837
|
+
},
|
|
1838
|
+
{
|
|
1839
|
+
name: "strokePaint",
|
|
1840
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
1841
|
+
typeSummary: "GradientPaint",
|
|
1842
|
+
required: false,
|
|
1843
|
+
},
|
|
1844
|
+
{
|
|
1845
|
+
name: "glow",
|
|
1846
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
1847
|
+
typeSummary: "GlowSpec",
|
|
1848
|
+
required: false,
|
|
1849
|
+
},
|
|
1850
|
+
],
|
|
1851
|
+
},
|
|
1852
|
+
hex: {
|
|
1853
|
+
name: "hex",
|
|
1854
|
+
slug: "hex",
|
|
1855
|
+
component: "GeomHex",
|
|
1856
|
+
summary: "Hexagonal bin heatmap: partitions continuous x×y into a hexagonal lattice and maps fill to bin count by default.",
|
|
1857
|
+
defaultStat: "bin_hex",
|
|
1858
|
+
defaultPosition: "identity",
|
|
1859
|
+
allowedStats: ["bin_hex"],
|
|
1860
|
+
allowedPositions: ["identity"],
|
|
1861
|
+
paramsType: "HexParams",
|
|
1862
|
+
params: [
|
|
1863
|
+
{
|
|
1864
|
+
name: "bins",
|
|
1865
|
+
description: "Approximate number of hex bins across the x range. Default 30.",
|
|
1866
|
+
typeSummary: "number",
|
|
1867
|
+
required: false,
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
name: "drop",
|
|
1871
|
+
description: "When true (default), omit zero-count hexes from the output.",
|
|
1872
|
+
typeSummary: "boolean",
|
|
1873
|
+
required: false,
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
name: "alpha",
|
|
1877
|
+
description: "Hex opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1878
|
+
typeSummary: "number",
|
|
1879
|
+
required: false,
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
name: "linewidth",
|
|
1883
|
+
description: "Outline stroke width in px when color is set. Default 0 (no outline).",
|
|
1884
|
+
typeSummary: "number",
|
|
1885
|
+
required: false,
|
|
1886
|
+
},
|
|
1887
|
+
],
|
|
1888
|
+
},
|
|
1889
|
+
bin_2d: {
|
|
1890
|
+
name: "bin_2d",
|
|
1891
|
+
slug: "bin_2d",
|
|
1892
|
+
component: "GeomBin2d",
|
|
1893
|
+
summary: "2D rectangular bin heatmap: partitions continuous x×y into a grid and maps fill to bin count by default. Empty bins are dropped unless params.drop is false.",
|
|
1894
|
+
defaultStat: "bin_2d",
|
|
1895
|
+
defaultPosition: "identity",
|
|
1896
|
+
allowedStats: ["bin_2d"],
|
|
1897
|
+
allowedPositions: ["identity"],
|
|
1898
|
+
paramsType: "Bin2dParams",
|
|
1899
|
+
params: [
|
|
1900
|
+
{
|
|
1901
|
+
name: "bins",
|
|
1902
|
+
description: "Number of bins on each axis. Default 30. Applies equally to x and y in v1.",
|
|
1903
|
+
typeSummary: "number",
|
|
1904
|
+
required: false,
|
|
1905
|
+
},
|
|
1906
|
+
{
|
|
1907
|
+
name: "binwidth",
|
|
1908
|
+
description: "Shared bin width in data units for both axes (overrides bins). Prefer when the scale units are meaningful.",
|
|
1909
|
+
typeSummary: "number",
|
|
1910
|
+
required: false,
|
|
1911
|
+
},
|
|
1912
|
+
{
|
|
1913
|
+
name: "drop",
|
|
1914
|
+
description: "When true (default), omit zero-count bins from the output.",
|
|
1915
|
+
typeSummary: "boolean",
|
|
1916
|
+
required: false,
|
|
1917
|
+
},
|
|
1918
|
+
{
|
|
1919
|
+
name: "alpha",
|
|
1920
|
+
description: "Cell opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1921
|
+
typeSummary: "number",
|
|
1922
|
+
required: false,
|
|
1923
|
+
},
|
|
1924
|
+
{
|
|
1925
|
+
name: "linewidth",
|
|
1926
|
+
description: "Outline stroke width in px when color is set. Must be greater than 0.",
|
|
1927
|
+
typeSummary: "number",
|
|
1928
|
+
required: false,
|
|
1929
|
+
},
|
|
1930
|
+
],
|
|
1931
|
+
},
|
|
1932
|
+
abline: {
|
|
1933
|
+
name: "abline",
|
|
1934
|
+
slug: "abline",
|
|
1935
|
+
component: "GeomAbline",
|
|
1936
|
+
summary: "Abline geometry: one infinite reference line y = intercept + slope · x, clipped to the panel. Annotation form: fixed slope/intercept in params; does not inherit plot aes.",
|
|
1937
|
+
defaultStat: "identity",
|
|
1938
|
+
defaultPosition: "identity",
|
|
1939
|
+
allowedStats: ["identity"],
|
|
1940
|
+
allowedPositions: ["identity"],
|
|
1941
|
+
paramsType: "AblineParams",
|
|
1942
|
+
params: [
|
|
1943
|
+
{
|
|
1944
|
+
name: "slope",
|
|
1945
|
+
description: "Line slope (rise/run). Default 1 (identity line when intercept is 0).",
|
|
1946
|
+
typeSummary: "number",
|
|
1947
|
+
required: false,
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
name: "intercept",
|
|
1951
|
+
description: "Y-intercept in data units. Default 0.",
|
|
1952
|
+
typeSummary: "number",
|
|
1953
|
+
required: false,
|
|
1954
|
+
},
|
|
1955
|
+
{
|
|
1956
|
+
name: "alpha",
|
|
1957
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
1958
|
+
typeSummary: "number",
|
|
1959
|
+
required: false,
|
|
1960
|
+
},
|
|
1961
|
+
{
|
|
1962
|
+
name: "linewidth",
|
|
1963
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
1964
|
+
typeSummary: "number",
|
|
1965
|
+
required: false,
|
|
1966
|
+
},
|
|
1967
|
+
],
|
|
1968
|
+
},
|
|
1969
|
+
curve: {
|
|
1970
|
+
name: "curve",
|
|
1971
|
+
slug: "curve",
|
|
1972
|
+
component: "GeomCurve",
|
|
1973
|
+
summary: "Curve geometry: one curved connector per row from (x, y) to (xend, yend). Tessellated as a quadratic Bezier (curvature/angle/ncp). Requires field-mapped x, y, xend, and yend.",
|
|
1974
|
+
defaultStat: "identity",
|
|
1975
|
+
defaultPosition: "identity",
|
|
1976
|
+
allowedStats: ["identity"],
|
|
1977
|
+
allowedPositions: ["identity"],
|
|
1978
|
+
paramsType: "CurveParams",
|
|
1979
|
+
params: [
|
|
1980
|
+
{
|
|
1981
|
+
name: "curvature",
|
|
1982
|
+
description: "Amount of bend away from the straight chord. 0 is a straight line; default 0.5. Positive bows to the right of the start→end direction when angle is 90.",
|
|
1983
|
+
typeSummary: "number",
|
|
1984
|
+
required: false,
|
|
1985
|
+
},
|
|
1986
|
+
{
|
|
1987
|
+
name: "angle",
|
|
1988
|
+
description: "Control-point direction relative to the chord, in degrees. default 90 (perpendicular).",
|
|
1989
|
+
typeSummary: "number",
|
|
1990
|
+
required: false,
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
name: "ncp",
|
|
1994
|
+
description: "Smoothness density knob. Maps to tessellation sample count = max(8, ncp×8); not multi-control xspline. Default 5.",
|
|
1995
|
+
typeSummary: "number",
|
|
1996
|
+
required: false,
|
|
1997
|
+
},
|
|
1998
|
+
{
|
|
1999
|
+
name: "alpha",
|
|
2000
|
+
description: "Curve opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2001
|
+
typeSummary: "number",
|
|
2002
|
+
required: false,
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
name: "linewidth",
|
|
2006
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
2007
|
+
typeSummary: "number",
|
|
2008
|
+
required: false,
|
|
2009
|
+
},
|
|
2010
|
+
{
|
|
2011
|
+
name: "lineend",
|
|
2012
|
+
description: 'SVG stroke-linecap for curve ends. Default "butt".',
|
|
2013
|
+
typeSummary: '"butt" | "round" | "square"',
|
|
2014
|
+
required: false,
|
|
2015
|
+
},
|
|
2016
|
+
{
|
|
2017
|
+
name: "strokePaint",
|
|
2018
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
2019
|
+
typeSummary: "GradientPaint",
|
|
2020
|
+
required: false,
|
|
2021
|
+
},
|
|
2022
|
+
{
|
|
2023
|
+
name: "glow",
|
|
2024
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
2025
|
+
typeSummary: "GlowSpec",
|
|
2026
|
+
required: false,
|
|
2027
|
+
},
|
|
2028
|
+
],
|
|
2029
|
+
},
|
|
2030
|
+
contour: {
|
|
2031
|
+
name: "contour",
|
|
2032
|
+
slug: "contour",
|
|
2033
|
+
component: "GeomContour",
|
|
2034
|
+
summary: "Contour geometry: isolines of a continuous z surface over a regular x×y grid. v1 draws open path polylines only (not filled bands).",
|
|
2035
|
+
defaultStat: "contour",
|
|
2036
|
+
defaultPosition: "identity",
|
|
2037
|
+
allowedStats: ["contour"],
|
|
2038
|
+
allowedPositions: ["identity"],
|
|
2039
|
+
paramsType: "ContourParams",
|
|
2040
|
+
params: [
|
|
2041
|
+
{
|
|
2042
|
+
name: "bins",
|
|
2043
|
+
description: "Number of evenly spaced contour levels from min(z) to max(z) inclusive (integer ≥ 1). Default 10. Overridden by breaks or binwidth.",
|
|
2044
|
+
typeSummary: "number",
|
|
2045
|
+
required: false,
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
name: "binwidth",
|
|
2049
|
+
description: "Contour level step in z units (must be greater than 0). Takes precedence over bins; overridden by breaks.",
|
|
2050
|
+
typeSummary: "number",
|
|
2051
|
+
required: false,
|
|
2052
|
+
},
|
|
2053
|
+
{
|
|
2054
|
+
name: "breaks",
|
|
2055
|
+
description: "Explicit contour levels (finite numbers). Overrides bins and binwidth when non-empty.",
|
|
2056
|
+
typeSummary: "Array<number>",
|
|
2057
|
+
required: false,
|
|
2058
|
+
},
|
|
2059
|
+
{
|
|
2060
|
+
name: "linewidth",
|
|
2061
|
+
description: "Stroke width of contour lines in px. Must be greater than 0. Default 1.",
|
|
2062
|
+
typeSummary: "number",
|
|
2063
|
+
required: false,
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
name: "alpha",
|
|
2067
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2068
|
+
typeSummary: "number",
|
|
2069
|
+
required: false,
|
|
2070
|
+
},
|
|
2071
|
+
],
|
|
2072
|
+
},
|
|
2073
|
+
density_2d: {
|
|
2074
|
+
name: "density_2d",
|
|
2075
|
+
slug: "density_2d",
|
|
2076
|
+
component: "GeomDensity2d",
|
|
2077
|
+
summary: "2D density geometry: bivariate KDE isolines over continuous x and y. Open path contours.",
|
|
2078
|
+
defaultStat: "density_2d",
|
|
2079
|
+
defaultPosition: "identity",
|
|
2080
|
+
allowedStats: ["density_2d"],
|
|
2081
|
+
allowedPositions: ["identity"],
|
|
2082
|
+
paramsType: "Density2dParams",
|
|
2083
|
+
params: [
|
|
2084
|
+
{
|
|
2085
|
+
name: "h",
|
|
2086
|
+
description: "Kernel bandwidth: one positive number for both axes, or [hx, hy]. Omit for MASS bandwidth.nrd per axis (then kde2d h/4 scaling).",
|
|
2087
|
+
typeSummary: "number | Array<number>",
|
|
2088
|
+
required: false,
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
name: "adjust",
|
|
2092
|
+
description: "Bandwidth multiplier (must be greater than 0). Default 1.",
|
|
2093
|
+
typeSummary: "number",
|
|
2094
|
+
required: false,
|
|
2095
|
+
},
|
|
2096
|
+
{
|
|
2097
|
+
name: "n",
|
|
2098
|
+
description: "Grid resolution per axis for the KDE surface (integer 10–200). Default 100.",
|
|
2099
|
+
typeSummary: "number",
|
|
2100
|
+
required: false,
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
name: "bins",
|
|
2104
|
+
description: "Number of contour levels of the density surface (integer ≥ 1). Default 10. Overridden by breaks.",
|
|
2105
|
+
typeSummary: "number",
|
|
2106
|
+
required: false,
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
name: "binwidth",
|
|
2110
|
+
description: "Contour level step in density units. Overridden by breaks.",
|
|
2111
|
+
typeSummary: "number",
|
|
2112
|
+
required: false,
|
|
2113
|
+
},
|
|
2114
|
+
{
|
|
2115
|
+
name: "breaks",
|
|
2116
|
+
description: "Explicit density contour levels. Overrides bins and binwidth.",
|
|
2117
|
+
typeSummary: "Array<number>",
|
|
2118
|
+
required: false,
|
|
2119
|
+
},
|
|
2120
|
+
{
|
|
2121
|
+
name: "linewidth",
|
|
2122
|
+
description: "Stroke width of density contours in px. Must be greater than 0. Default 1.",
|
|
2123
|
+
typeSummary: "number",
|
|
2124
|
+
required: false,
|
|
2125
|
+
},
|
|
2126
|
+
{
|
|
2127
|
+
name: "alpha",
|
|
2128
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2129
|
+
typeSummary: "number",
|
|
2130
|
+
required: false,
|
|
2131
|
+
},
|
|
2132
|
+
],
|
|
2133
|
+
},
|
|
2134
|
+
density_2d_filled: {
|
|
2135
|
+
name: "density_2d_filled",
|
|
2136
|
+
slug: "density_2d_filled",
|
|
2137
|
+
component: "GeomDensity2dFilled",
|
|
2138
|
+
summary: "2D density filled bands: bivariate KDE closed isoline rings filled by density level. Open rings dropped. Defaults fill to after_stat(level).",
|
|
2139
|
+
defaultStat: "density_2d_filled",
|
|
2140
|
+
defaultPosition: "identity",
|
|
2141
|
+
allowedStats: ["density_2d_filled"],
|
|
2142
|
+
allowedPositions: ["identity"],
|
|
2143
|
+
paramsType: "Density2dParams",
|
|
2144
|
+
params: [
|
|
2145
|
+
{
|
|
2146
|
+
name: "h",
|
|
2147
|
+
description: "Kernel bandwidth: one positive number for both axes, or [hx, hy]. Omit for MASS bandwidth.nrd per axis (then kde2d h/4 scaling).",
|
|
2148
|
+
typeSummary: "number | Array<number>",
|
|
2149
|
+
required: false,
|
|
2150
|
+
},
|
|
2151
|
+
{
|
|
2152
|
+
name: "adjust",
|
|
2153
|
+
description: "Bandwidth multiplier (must be greater than 0). Default 1.",
|
|
2154
|
+
typeSummary: "number",
|
|
2155
|
+
required: false,
|
|
2156
|
+
},
|
|
2157
|
+
{
|
|
2158
|
+
name: "n",
|
|
2159
|
+
description: "Grid resolution per axis for the KDE surface (integer 10–200). Default 100.",
|
|
2160
|
+
typeSummary: "number",
|
|
2161
|
+
required: false,
|
|
2162
|
+
},
|
|
2163
|
+
{
|
|
2164
|
+
name: "bins",
|
|
2165
|
+
description: "Number of contour levels of the density surface (integer ≥ 1). Default 10. Overridden by breaks.",
|
|
2166
|
+
typeSummary: "number",
|
|
2167
|
+
required: false,
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
name: "binwidth",
|
|
2171
|
+
description: "Contour level step in density units. Overridden by breaks.",
|
|
2172
|
+
typeSummary: "number",
|
|
2173
|
+
required: false,
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
name: "breaks",
|
|
2177
|
+
description: "Explicit density contour levels. Overrides bins and binwidth.",
|
|
2178
|
+
typeSummary: "Array<number>",
|
|
2179
|
+
required: false,
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
name: "linewidth",
|
|
2183
|
+
description: "Stroke width of density contours in px. Must be greater than 0. Default 1.",
|
|
2184
|
+
typeSummary: "number",
|
|
2185
|
+
required: false,
|
|
2186
|
+
},
|
|
2187
|
+
{
|
|
2188
|
+
name: "alpha",
|
|
2189
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2190
|
+
typeSummary: "number",
|
|
2191
|
+
required: false,
|
|
2192
|
+
},
|
|
2193
|
+
],
|
|
2194
|
+
},
|
|
2195
|
+
dotplot: {
|
|
2196
|
+
name: "dotplot",
|
|
2197
|
+
slug: "dotplot",
|
|
2198
|
+
component: "GeomDotplot",
|
|
2199
|
+
summary: "Dotplot geometry: stacked dots along a continuous x axis (histodot subset). Do not map aes.y — the bindot stat computes stack positions.",
|
|
2200
|
+
defaultStat: "bindot",
|
|
2201
|
+
defaultPosition: "identity",
|
|
2202
|
+
allowedStats: ["bindot"],
|
|
2203
|
+
allowedPositions: ["identity"],
|
|
2204
|
+
paramsType: "DotplotParams",
|
|
2205
|
+
params: [
|
|
2206
|
+
{
|
|
2207
|
+
name: "bins",
|
|
2208
|
+
description: "Number of bins (integer ≥ 1). Default 30 — advisory when neither bins nor binwidth is set. Overridden by binwidth.",
|
|
2209
|
+
typeSummary: "number",
|
|
2210
|
+
required: false,
|
|
2211
|
+
},
|
|
2212
|
+
{
|
|
2213
|
+
name: "binwidth",
|
|
2214
|
+
description: "Histodot bin width in data units (must be greater than 0). Takes precedence over bins. Also drives default point diameter via the x scale.",
|
|
2215
|
+
typeSummary: "number",
|
|
2216
|
+
required: false,
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
name: "boundary",
|
|
2220
|
+
description: "Align a bin edge to this value (mutually exclusive with center).",
|
|
2221
|
+
typeSummary: "number",
|
|
2222
|
+
required: false,
|
|
2223
|
+
},
|
|
2224
|
+
{
|
|
2225
|
+
name: "center",
|
|
2226
|
+
description: "Align a bin center to this value (mutually exclusive with boundary).",
|
|
2227
|
+
typeSummary: "number",
|
|
2228
|
+
required: false,
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
name: "closed",
|
|
2232
|
+
description: 'Which side of each bin is closed: "right" (default, (lo, hi]) or "left" ([lo, hi)).',
|
|
2233
|
+
typeSummary: '"right" | "left"',
|
|
2234
|
+
required: false,
|
|
2235
|
+
},
|
|
2236
|
+
{
|
|
2237
|
+
name: "stackdir",
|
|
2238
|
+
description: 'Stack direction: "up" (default), "down", "center", or "centerwhole" (integer-aligned center).',
|
|
2239
|
+
typeSummary: '"up" | "down" | "center" | "centerwhole"',
|
|
2240
|
+
required: false,
|
|
2241
|
+
},
|
|
2242
|
+
{
|
|
2243
|
+
name: "stackratio",
|
|
2244
|
+
description: "Relative spacing between stacked dots (must be greater than 0). Default 1.",
|
|
2245
|
+
typeSummary: "number",
|
|
2246
|
+
required: false,
|
|
2247
|
+
},
|
|
2248
|
+
{
|
|
2249
|
+
name: "dotsize",
|
|
2250
|
+
description: "Multiplier on diameter derived from binwidth × x-scale (must be greater than 0). Default 1. Ignored when params.size is set.",
|
|
2251
|
+
typeSummary: "number",
|
|
2252
|
+
required: false,
|
|
2253
|
+
},
|
|
2254
|
+
{
|
|
2255
|
+
name: "size",
|
|
2256
|
+
description: "Point radius in px (must be greater than 0). When set, overrides binwidth-derived sizing.",
|
|
2257
|
+
typeSummary: "number",
|
|
2258
|
+
required: false,
|
|
2259
|
+
},
|
|
2260
|
+
{
|
|
2261
|
+
name: "alpha",
|
|
2262
|
+
description: "Point opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2263
|
+
typeSummary: "number",
|
|
2264
|
+
required: false,
|
|
2265
|
+
},
|
|
2266
|
+
{
|
|
2267
|
+
name: "shape",
|
|
2268
|
+
description: 'Point shape. One of "circle", "triangle", "square", "diamond", "plus", "cross", "circle-open". Default "circle".',
|
|
2269
|
+
typeSummary: '"circle" | "triangle" | "square" | "diamond" | "plus" | "cross" | "circle-open"',
|
|
2270
|
+
required: false,
|
|
2271
|
+
},
|
|
2272
|
+
],
|
|
2273
|
+
},
|
|
2274
|
+
map: {
|
|
2275
|
+
name: "map",
|
|
2276
|
+
slug: "map",
|
|
2277
|
+
component: "GeomMap",
|
|
2278
|
+
summary: "Map geometry: join fortified region borders to value rows via aes.map_id and params.map. Renders closed filled paths per region.",
|
|
2279
|
+
defaultStat: "identity",
|
|
2280
|
+
defaultPosition: "identity",
|
|
2281
|
+
allowedStats: ["identity"],
|
|
2282
|
+
allowedPositions: ["identity"],
|
|
2283
|
+
paramsType: "MapParams",
|
|
2284
|
+
params: [
|
|
2285
|
+
{
|
|
2286
|
+
name: "map",
|
|
2287
|
+
description: "Fortified map coordinates ({ values }, { columns }, or { name } against spec.datasets). Must include long+lat or x+y, plus a region id column.",
|
|
2288
|
+
typeSummary: "DataRef",
|
|
2289
|
+
required: true,
|
|
2290
|
+
},
|
|
2291
|
+
{
|
|
2292
|
+
name: "mapId",
|
|
2293
|
+
description: 'Join column name in the map data (matched to aes.map_id). Default: "region", then "id".',
|
|
2294
|
+
typeSummary: "string",
|
|
2295
|
+
required: false,
|
|
2296
|
+
},
|
|
2297
|
+
{
|
|
2298
|
+
name: "alpha",
|
|
2299
|
+
description: "Region fill opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2300
|
+
typeSummary: "number",
|
|
2301
|
+
required: false,
|
|
2302
|
+
},
|
|
2303
|
+
{
|
|
2304
|
+
name: "linewidth",
|
|
2305
|
+
description: "Region outline stroke width in px. Must be greater than 0. Default 1.5.",
|
|
2306
|
+
typeSummary: "number",
|
|
2307
|
+
required: false,
|
|
2308
|
+
},
|
|
2309
|
+
{
|
|
2310
|
+
name: "fillPaint",
|
|
2311
|
+
description: "Within-mark gradient fill paint (not a data scale).",
|
|
2312
|
+
typeSummary: "GradientPaint",
|
|
2313
|
+
required: false,
|
|
2314
|
+
},
|
|
2315
|
+
{
|
|
2316
|
+
name: "strokePaint",
|
|
2317
|
+
description: "Within-mark gradient stroke paint (not a data scale).",
|
|
2318
|
+
typeSummary: "GradientPaint",
|
|
2319
|
+
required: false,
|
|
2320
|
+
},
|
|
2321
|
+
{
|
|
2322
|
+
name: "glow",
|
|
2323
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
2324
|
+
typeSummary: "GlowSpec",
|
|
2325
|
+
required: false,
|
|
2326
|
+
},
|
|
2327
|
+
],
|
|
2328
|
+
},
|
|
2329
|
+
sf: {
|
|
2330
|
+
name: "sf",
|
|
2331
|
+
slug: "sf",
|
|
2332
|
+
component: "GeomSf",
|
|
2333
|
+
summary: "Simple-features geometry: already-projected GeoJSON Geometry JSON strings in a data column. Point/line/polygon families (incl. GeometryCollection of one family) with even-odd holes; use coord_sf for fixed-aspect (CRS reproject deferred).",
|
|
2334
|
+
defaultStat: "sf",
|
|
2335
|
+
defaultPosition: "identity",
|
|
2336
|
+
allowedStats: ["sf"],
|
|
2337
|
+
allowedPositions: ["identity"],
|
|
2338
|
+
paramsType: "SfParams",
|
|
2339
|
+
params: [
|
|
2340
|
+
{
|
|
2341
|
+
name: "geometry",
|
|
2342
|
+
description: 'Name of the data column holding GeoJSON Geometry JSON strings. Default "geometry". Already-projected coordinates only.',
|
|
2343
|
+
typeSummary: "string",
|
|
2344
|
+
required: false,
|
|
2345
|
+
},
|
|
2346
|
+
{
|
|
2347
|
+
name: "alpha",
|
|
2348
|
+
description: "Mark opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2349
|
+
typeSummary: "number",
|
|
2350
|
+
required: false,
|
|
2351
|
+
},
|
|
2352
|
+
{
|
|
2353
|
+
name: "linewidth",
|
|
2354
|
+
description: "Stroke width in px for lines/polygon outlines. Must be greater than 0.",
|
|
2355
|
+
typeSummary: "number",
|
|
2356
|
+
required: false,
|
|
2357
|
+
},
|
|
2358
|
+
{
|
|
2359
|
+
name: "size",
|
|
2360
|
+
description: "Point radius in px when geometries are Point/MultiPoint.",
|
|
2361
|
+
typeSummary: "number",
|
|
2362
|
+
required: false,
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
name: "fillPaint",
|
|
2366
|
+
description: "Within-mark gradient fill paint (polygon family; not a data scale).",
|
|
2367
|
+
typeSummary: "GradientPaint",
|
|
2368
|
+
required: false,
|
|
2369
|
+
},
|
|
2370
|
+
{
|
|
2371
|
+
name: "strokePaint",
|
|
2372
|
+
description: "Within-mark gradient stroke paint (not a data scale).",
|
|
2373
|
+
typeSummary: "GradientPaint",
|
|
2374
|
+
required: false,
|
|
2375
|
+
},
|
|
2376
|
+
{
|
|
2377
|
+
name: "glow",
|
|
2378
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
2379
|
+
typeSummary: "GlowSpec",
|
|
2380
|
+
required: false,
|
|
2381
|
+
},
|
|
2382
|
+
],
|
|
2383
|
+
},
|
|
2384
|
+
sf_text: {
|
|
2385
|
+
name: "sf_text",
|
|
2386
|
+
slug: "sf_text",
|
|
2387
|
+
component: "GeomSfText",
|
|
2388
|
+
summary: "Simple-features text labels: places aes.label at representative geometry points (Multi* → one label per part; stat_sf_coordinates).",
|
|
2389
|
+
defaultStat: "sf_coordinates",
|
|
2390
|
+
defaultPosition: "identity",
|
|
2391
|
+
allowedStats: ["sf_coordinates"],
|
|
2392
|
+
allowedPositions: ["identity"],
|
|
2393
|
+
paramsType: "SfTextParams",
|
|
2394
|
+
params: [
|
|
2395
|
+
{
|
|
2396
|
+
name: "geometry",
|
|
2397
|
+
description: 'Name of the data column holding GeoJSON Geometry JSON strings. Default "geometry".',
|
|
2398
|
+
typeSummary: "string",
|
|
2399
|
+
required: false,
|
|
2400
|
+
},
|
|
2401
|
+
{
|
|
2402
|
+
name: "alpha",
|
|
2403
|
+
description: "Text opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2404
|
+
typeSummary: "number",
|
|
2405
|
+
required: false,
|
|
2406
|
+
},
|
|
2407
|
+
{
|
|
2408
|
+
name: "size",
|
|
2409
|
+
description: "Font size in px. Must be greater than 0. Default 11.",
|
|
2410
|
+
typeSummary: "number",
|
|
2411
|
+
required: false,
|
|
2412
|
+
},
|
|
2413
|
+
{
|
|
2414
|
+
name: "anchor",
|
|
2415
|
+
description: 'Horizontal text anchor relative to the representative point: "start", "middle" (default), or "end".',
|
|
2416
|
+
typeSummary: '"start" | "middle" | "end"',
|
|
2417
|
+
required: false,
|
|
2418
|
+
},
|
|
2419
|
+
{
|
|
2420
|
+
name: "dx",
|
|
2421
|
+
description: "Horizontal offset in px applied after positioning. Default 0.",
|
|
2422
|
+
typeSummary: "number",
|
|
2423
|
+
required: false,
|
|
2424
|
+
},
|
|
2425
|
+
{
|
|
2426
|
+
name: "dy",
|
|
2427
|
+
description: "Vertical offset in px applied after positioning (positive = down). Default 0.",
|
|
2428
|
+
typeSummary: "number",
|
|
2429
|
+
required: false,
|
|
2430
|
+
},
|
|
2431
|
+
],
|
|
2432
|
+
},
|
|
2433
|
+
sf_label: {
|
|
2434
|
+
name: "sf_label",
|
|
2435
|
+
slug: "sf_label",
|
|
2436
|
+
component: "GeomSfLabel",
|
|
2437
|
+
summary: "Simple-features labels with background boxes: places aes.label at representative geometry points with a measured rounded rect (Multi* → one label per part). color=ink+box stroke; fill=box background.",
|
|
2438
|
+
defaultStat: "sf_coordinates",
|
|
2439
|
+
defaultPosition: "identity",
|
|
2440
|
+
allowedStats: ["sf_coordinates"],
|
|
2441
|
+
allowedPositions: ["identity"],
|
|
2442
|
+
paramsType: "SfLabelParams",
|
|
2443
|
+
params: [
|
|
2444
|
+
{
|
|
2445
|
+
name: "geometry",
|
|
2446
|
+
description: 'Name of the data column holding GeoJSON Geometry JSON strings. Default "geometry".',
|
|
2447
|
+
typeSummary: "string",
|
|
2448
|
+
required: false,
|
|
2449
|
+
},
|
|
2450
|
+
{
|
|
2451
|
+
name: "alpha",
|
|
2452
|
+
description: "Label opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2453
|
+
typeSummary: "number",
|
|
2454
|
+
required: false,
|
|
2455
|
+
},
|
|
2456
|
+
{
|
|
2457
|
+
name: "size",
|
|
2458
|
+
description: "Font size in px. Must be greater than 0. Default 11.",
|
|
2459
|
+
typeSummary: "number",
|
|
2460
|
+
required: false,
|
|
2461
|
+
},
|
|
2462
|
+
{
|
|
2463
|
+
name: "anchor",
|
|
2464
|
+
description: 'Horizontal text anchor relative to the representative point: "start", "middle" (default), or "end".',
|
|
2465
|
+
typeSummary: '"start" | "middle" | "end"',
|
|
2466
|
+
required: false,
|
|
2467
|
+
},
|
|
2468
|
+
{
|
|
2469
|
+
name: "dx",
|
|
2470
|
+
description: "Horizontal offset in px applied after positioning. Default 0.",
|
|
2471
|
+
typeSummary: "number",
|
|
2472
|
+
required: false,
|
|
2473
|
+
},
|
|
2474
|
+
{
|
|
2475
|
+
name: "dy",
|
|
2476
|
+
description: "Vertical offset in px applied after positioning (positive = down). Default 0.",
|
|
2477
|
+
typeSummary: "number",
|
|
2478
|
+
required: false,
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
name: "padding",
|
|
2482
|
+
description: "Box padding around the text in px. Default 3.",
|
|
2483
|
+
typeSummary: "number",
|
|
2484
|
+
required: false,
|
|
2485
|
+
},
|
|
2486
|
+
{
|
|
2487
|
+
name: "radius",
|
|
2488
|
+
description: "Box corner radius in px. Default 3.",
|
|
2489
|
+
typeSummary: "number",
|
|
2490
|
+
required: false,
|
|
2491
|
+
},
|
|
2492
|
+
{
|
|
2493
|
+
name: "linewidth",
|
|
2494
|
+
description: "Box stroke width in px. Default 0.5.",
|
|
2495
|
+
typeSummary: "number",
|
|
2496
|
+
required: false,
|
|
2497
|
+
},
|
|
2498
|
+
],
|
|
2499
|
+
},
|
|
2500
|
+
blank: {
|
|
2501
|
+
name: "blank",
|
|
2502
|
+
slug: "blank",
|
|
2503
|
+
component: "GeomBlank",
|
|
2504
|
+
summary: "Blank geometry: contributes mapped aesthetics to scale training and layout without drawing marks or hit targets. No channels are required; whatever is mapped trains its scale.",
|
|
2505
|
+
defaultStat: "identity",
|
|
2506
|
+
defaultPosition: "identity",
|
|
2507
|
+
allowedStats: ["identity"],
|
|
2508
|
+
allowedPositions: ["identity"],
|
|
2509
|
+
paramsType: "BlankParams",
|
|
2510
|
+
params: [],
|
|
2511
|
+
},
|
|
2512
|
+
jitter: {
|
|
2513
|
+
name: "jitter",
|
|
2514
|
+
slug: "jitter",
|
|
2515
|
+
component: "GeomJitter",
|
|
2516
|
+
summary: "Jittered point alias. Canonicalized by normalize() to a point layer with position jitter. Configure jitter amount via positionParams.width/height/seed.",
|
|
2517
|
+
defaultStat: "identity",
|
|
2518
|
+
defaultPosition: "jitter",
|
|
2519
|
+
allowedStats: ["identity"],
|
|
2520
|
+
allowedPositions: ["jitter"],
|
|
2521
|
+
paramsType: "PointParams",
|
|
2522
|
+
params: [
|
|
2523
|
+
{
|
|
2524
|
+
name: "alpha",
|
|
2525
|
+
description: "Point opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2526
|
+
typeSummary: "number",
|
|
2527
|
+
required: false,
|
|
2528
|
+
},
|
|
2529
|
+
{
|
|
2530
|
+
name: "size",
|
|
2531
|
+
description: "Point radius in px. Must be greater than 0. Default 2.5.",
|
|
2532
|
+
typeSummary: "number",
|
|
2533
|
+
required: false,
|
|
2534
|
+
},
|
|
2535
|
+
{
|
|
2536
|
+
name: "shape",
|
|
2537
|
+
description: 'Point shape. One of "circle", "triangle", "square", "diamond", "plus", "cross", "circle-open". Default "circle".',
|
|
2538
|
+
typeSummary: '"circle" | "triangle" | "square" | "diamond" | "plus" | "cross" | "circle-open"',
|
|
2539
|
+
required: false,
|
|
2540
|
+
},
|
|
2541
|
+
{
|
|
2542
|
+
name: "bins",
|
|
2543
|
+
description: "STAT SUMMARY_BIN ONLY: number of bins (integer ≥ 1). Default 30 — advisory. Overridden by binwidth.",
|
|
2544
|
+
typeSummary: "number",
|
|
2545
|
+
required: false,
|
|
2546
|
+
},
|
|
2547
|
+
{
|
|
2548
|
+
name: "binwidth",
|
|
2549
|
+
description: "STAT SUMMARY_BIN ONLY: bin width in data units (must be greater than 0). Takes precedence over bins.",
|
|
2550
|
+
typeSummary: "number",
|
|
2551
|
+
required: false,
|
|
2552
|
+
},
|
|
2553
|
+
{
|
|
2554
|
+
name: "boundary",
|
|
2555
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin EDGE with this x value. Mutually exclusive with center.",
|
|
2556
|
+
typeSummary: "number",
|
|
2557
|
+
required: false,
|
|
2558
|
+
},
|
|
2559
|
+
{
|
|
2560
|
+
name: "center",
|
|
2561
|
+
description: "STAT SUMMARY_BIN ONLY: align a bin CENTER with this x value. Mutually exclusive with boundary.",
|
|
2562
|
+
typeSummary: "number",
|
|
2563
|
+
required: false,
|
|
2564
|
+
},
|
|
2565
|
+
{
|
|
2566
|
+
name: "closed",
|
|
2567
|
+
description: 'STAT SUMMARY_BIN ONLY: which edge of each bin is inclusive: "right" (default) or "left".',
|
|
2568
|
+
typeSummary: '"right" | "left"',
|
|
2569
|
+
required: false,
|
|
2570
|
+
},
|
|
2571
|
+
{
|
|
2572
|
+
name: "window",
|
|
2573
|
+
description: 'STAT SUMMARY_ROLLING ONLY: centered rolling-window width in x data units (must be greater than 0). Required when stat is "summary_rolling".',
|
|
2574
|
+
typeSummary: "number",
|
|
2575
|
+
required: false,
|
|
2576
|
+
},
|
|
2577
|
+
{
|
|
2578
|
+
name: "fun",
|
|
2579
|
+
description: 'SUMMARY_BIN / SUMMARY_ROLLING center fun (mean/median/sum;) or MANUAL named transform (first|last|mean|median|min|max|sum;). Required when stat is "manual".',
|
|
2580
|
+
typeSummary: '"first" | "last" | "mean" | "median" | "min" | "max" | "sum"',
|
|
2581
|
+
required: false,
|
|
2582
|
+
},
|
|
2583
|
+
{
|
|
2584
|
+
name: "funMin",
|
|
2585
|
+
description: "STAT SUMMARY_BIN ONLY: lower bound summary (ymin).",
|
|
2586
|
+
typeSummary: "SummaryFun",
|
|
2587
|
+
required: false,
|
|
2588
|
+
},
|
|
2589
|
+
{
|
|
2590
|
+
name: "funMax",
|
|
2591
|
+
description: "STAT SUMMARY_BIN ONLY: upper bound summary (ymax).",
|
|
2592
|
+
typeSummary: "SummaryFun",
|
|
2593
|
+
required: false,
|
|
2594
|
+
},
|
|
2595
|
+
],
|
|
2596
|
+
aliasOf: "point",
|
|
2597
|
+
},
|
|
2598
|
+
spoke: {
|
|
2599
|
+
name: "spoke",
|
|
2600
|
+
slug: "spoke",
|
|
2601
|
+
component: "GeomSpoke",
|
|
2602
|
+
summary: "Spoke geometry: one finite segment per row from (x, y) in direction angle (radians) with length radius. Endpoints are derived as xend = x + radius·cos(angle), yend = y + radius·sin(angle) in data space, then transformed like x/y. Requires continuous x and y.",
|
|
2603
|
+
defaultStat: "identity",
|
|
2604
|
+
defaultPosition: "identity",
|
|
2605
|
+
allowedStats: ["identity"],
|
|
2606
|
+
allowedPositions: ["identity"],
|
|
2607
|
+
paramsType: "SpokeParams",
|
|
2608
|
+
params: [
|
|
2609
|
+
{
|
|
2610
|
+
name: "angle",
|
|
2611
|
+
description: "Constant spoke direction in radians when aes.angle is not mapped. 0 = +x, π/2 = +y.",
|
|
2612
|
+
typeSummary: "number",
|
|
2613
|
+
required: false,
|
|
2614
|
+
},
|
|
2615
|
+
{
|
|
2616
|
+
name: "radius",
|
|
2617
|
+
description: "Constant spoke length in data units when aes.radius is not mapped. Must be greater than 0.",
|
|
2618
|
+
typeSummary: "number",
|
|
2619
|
+
required: false,
|
|
2620
|
+
},
|
|
2621
|
+
{
|
|
2622
|
+
name: "alpha",
|
|
2623
|
+
description: "Spoke opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2624
|
+
typeSummary: "number",
|
|
2625
|
+
required: false,
|
|
2626
|
+
},
|
|
2627
|
+
{
|
|
2628
|
+
name: "linewidth",
|
|
2629
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
2630
|
+
typeSummary: "number",
|
|
2631
|
+
required: false,
|
|
2632
|
+
},
|
|
2633
|
+
{
|
|
2634
|
+
name: "lineend",
|
|
2635
|
+
description: 'SVG stroke-linecap for spoke ends. Default "butt".',
|
|
2636
|
+
typeSummary: '"butt" | "round" | "square"',
|
|
2637
|
+
required: false,
|
|
2638
|
+
},
|
|
2639
|
+
{
|
|
2640
|
+
name: "strokePaint",
|
|
2641
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
2642
|
+
typeSummary: "GradientPaint",
|
|
2643
|
+
required: false,
|
|
2644
|
+
},
|
|
2645
|
+
{
|
|
2646
|
+
name: "glow",
|
|
2647
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
2648
|
+
typeSummary: "GlowSpec",
|
|
2649
|
+
required: false,
|
|
2650
|
+
},
|
|
2651
|
+
],
|
|
2652
|
+
},
|
|
2653
|
+
rug: {
|
|
2654
|
+
name: "rug",
|
|
2655
|
+
slug: "rug",
|
|
2656
|
+
component: "GeomRug",
|
|
2657
|
+
summary: "Rug geometry: short ticks along panel edges for each observation. Map aes.x for bottom/top sides and/or aes.y for left/right sides.",
|
|
2658
|
+
defaultStat: "identity",
|
|
2659
|
+
defaultPosition: "identity",
|
|
2660
|
+
allowedStats: ["identity"],
|
|
2661
|
+
allowedPositions: ["identity"],
|
|
2662
|
+
paramsType: "RugParams",
|
|
2663
|
+
params: [
|
|
2664
|
+
{
|
|
2665
|
+
name: "sides",
|
|
2666
|
+
description: 'Which panel edges get ticks: any non-empty combination of "b" (bottom), "l" (left), "t" (top), "r" (right). Default "bl". Duplicates are treated as a set. Sides b/t require aes.x; sides l/r require aes.y.',
|
|
2667
|
+
typeSummary: "string",
|
|
2668
|
+
required: false,
|
|
2669
|
+
},
|
|
2670
|
+
{
|
|
2671
|
+
name: "length",
|
|
2672
|
+
description: 'Tick length as a fraction of the panel size along the tick axis (panel-fraction npc analogue of unit(0.03, "npc")). Default 0.03.',
|
|
2673
|
+
typeSummary: "number",
|
|
2674
|
+
required: false,
|
|
2675
|
+
},
|
|
2676
|
+
{
|
|
2677
|
+
name: "alpha",
|
|
2678
|
+
description: "Tick opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2679
|
+
typeSummary: "number",
|
|
2680
|
+
required: false,
|
|
2681
|
+
},
|
|
2682
|
+
{
|
|
2683
|
+
name: "linewidth",
|
|
2684
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
2685
|
+
typeSummary: "number",
|
|
2686
|
+
required: false,
|
|
2687
|
+
},
|
|
2688
|
+
],
|
|
2689
|
+
},
|
|
2690
|
+
step: {
|
|
2691
|
+
name: "step",
|
|
2692
|
+
slug: "step",
|
|
2693
|
+
component: "GeomStep",
|
|
2694
|
+
summary: "Step-line geometry: connect points with hv/vh/mid stairs. Same channels as line; ordered by x within groups.",
|
|
2695
|
+
defaultStat: "identity",
|
|
2696
|
+
defaultPosition: "identity",
|
|
2697
|
+
allowedStats: ["identity"],
|
|
2698
|
+
allowedPositions: ["identity"],
|
|
2699
|
+
paramsType: "StepParams",
|
|
2700
|
+
params: [
|
|
2701
|
+
{
|
|
2702
|
+
name: "alpha",
|
|
2703
|
+
description: "Step-line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2704
|
+
typeSummary: "number",
|
|
2705
|
+
required: false,
|
|
2706
|
+
},
|
|
2707
|
+
{
|
|
2708
|
+
name: "linewidth",
|
|
2709
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.5.",
|
|
2710
|
+
typeSummary: "number",
|
|
2711
|
+
required: false,
|
|
2712
|
+
},
|
|
2713
|
+
{
|
|
2714
|
+
name: "direction",
|
|
2715
|
+
description: 'Step corner placement: "hv" horizontal then vertical (default), "vh" vertical then horizontal, "mid" change at the midpoint between x positions.',
|
|
2716
|
+
typeSummary: '"hv" | "vh" | "mid"',
|
|
2717
|
+
required: false,
|
|
2718
|
+
},
|
|
2719
|
+
{
|
|
2720
|
+
name: "strokePaint",
|
|
2721
|
+
description: "Within-mark gradient stroke paint (not a data scale). Requires a solid fallback.",
|
|
2722
|
+
typeSummary: "GradientPaint",
|
|
2723
|
+
required: false,
|
|
2724
|
+
},
|
|
2725
|
+
{
|
|
2726
|
+
name: "glow",
|
|
2727
|
+
description: "Bounded within-mark glow treatment (not theme decoration).",
|
|
2728
|
+
typeSummary: "GlowSpec",
|
|
2729
|
+
required: false,
|
|
2730
|
+
},
|
|
2731
|
+
],
|
|
2732
|
+
},
|
|
2733
|
+
qq: {
|
|
2734
|
+
name: "qq",
|
|
2735
|
+
slug: "qq",
|
|
2736
|
+
component: "GeomQq",
|
|
2737
|
+
summary: "Q–Q scatter: sample quantiles vs theoretical normal quantiles. Requires aes.sample.",
|
|
2738
|
+
defaultStat: "qq",
|
|
2739
|
+
defaultPosition: "identity",
|
|
2740
|
+
allowedStats: ["qq"],
|
|
2741
|
+
allowedPositions: ["identity"],
|
|
2742
|
+
paramsType: "QqParams",
|
|
2743
|
+
params: [
|
|
2744
|
+
{
|
|
2745
|
+
name: "alpha",
|
|
2746
|
+
description: "Point opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2747
|
+
typeSummary: "number",
|
|
2748
|
+
required: false,
|
|
2749
|
+
},
|
|
2750
|
+
{
|
|
2751
|
+
name: "size",
|
|
2752
|
+
description: "Point size in px. Must be greater than 0.",
|
|
2753
|
+
typeSummary: "number",
|
|
2754
|
+
required: false,
|
|
2755
|
+
},
|
|
2756
|
+
{
|
|
2757
|
+
name: "shape",
|
|
2758
|
+
description: 'Point shape. One of "circle", "triangle", "square", "diamond", "plus", "cross", "circle-open". Default "circle".',
|
|
2759
|
+
typeSummary: '"circle" | "triangle" | "square" | "diamond" | "plus" | "cross" | "circle-open"',
|
|
2760
|
+
required: false,
|
|
2761
|
+
},
|
|
2762
|
+
],
|
|
2763
|
+
},
|
|
2764
|
+
qq_line: {
|
|
2765
|
+
name: "qq_line",
|
|
2766
|
+
slug: "qq_line",
|
|
2767
|
+
component: "GeomQqLine",
|
|
2768
|
+
summary: "Q–Q reference line: line through sample/theoretical quartile match, spanning the theoretical range of the Q–Q cloud. Requires aes.sample.",
|
|
2769
|
+
defaultStat: "qq_line",
|
|
2770
|
+
defaultPosition: "identity",
|
|
2771
|
+
allowedStats: ["qq_line"],
|
|
2772
|
+
allowedPositions: ["identity"],
|
|
2773
|
+
paramsType: "QqLineParams",
|
|
2774
|
+
params: [
|
|
2775
|
+
{
|
|
2776
|
+
name: "alpha",
|
|
2777
|
+
description: "Line opacity. Must be between 0 and 1 (inclusive). Default 1.",
|
|
2778
|
+
typeSummary: "number",
|
|
2779
|
+
required: false,
|
|
2780
|
+
},
|
|
2781
|
+
{
|
|
2782
|
+
name: "linewidth",
|
|
2783
|
+
description: "Stroke width in px. Must be greater than 0. Default 1.",
|
|
2784
|
+
typeSummary: "number",
|
|
2785
|
+
required: false,
|
|
2786
|
+
},
|
|
2787
|
+
],
|
|
2788
|
+
},
|
|
2789
|
+
};
|
|
2790
|
+
//# sourceMappingURL=geom-reference-data.js.map
|