svelteplot 0.3.4 → 0.3.5-pr-121.1

package/dist/types/scale.d.ts

@@ -0,0 +1,143 @@
+import type { ScaleBand, ScaleLinear, ScaleOrdinal } from 'd3-scale';
+import type { ChannelAccessor, RawValue, ScaledChannelName } from '.';
+export type AxisXAnchor = 'bottom' | 'top' | 'both';
+export type AxisYAnchor = 'left' | 'right' | 'both';
+export type ScaleName = 'x' | 'y' | 'r' | 'color' | 'opacity' | 'length' | 'symbol' | 'fx' | 'fy' | 'projection';
+export type ScaleOptions = {
+    /**
+     * Override the automatic scale type detection.
+     */
+    type: ScaleType | 'auto';
+    /**
+     * Set a custom domain for the scale instead of auto-computing the domain
+     * from the mark data channels.
+     */
+    domain?: RawValue[];
+    /**
+     * Set a custom range for the scale.
+     */
+    range?: RawValue[];
+    /**
+     * Reverse the scale.
+     */
+    reverse: boolean;
+    label?: string;
+    interval?: string | number;
+    clamp: boolean;
+    nice: boolean;
+    zero: boolean;
+    round: boolean;
+    percent: boolean;
+    transform?: (d: RawValue) => RawValue;
+    /**
+     * set the padding for band scales
+     */
+    padding: number;
+    /**
+     * set the align for band or point scales
+     */
+    align: number;
+    /**
+     * set the inner padding for band scales
+     */
+    paddingInner?: number;
+    /**
+     * set the outer padding for band scales
+     */
+    paddingOuter?: number;
+    insetLeft?: number;
+    insetRight?: number;
+    insetTop?: number;
+    insetBottom?: number;
+    ticks?: (number | Date)[];
+    tickSpacing: number;
+    base?: number;
+    sort?: ChannelAccessor | ((a: RawValue, b: RawValue) => number) | {
+        channel: string;
+        order: 'ascending' | 'descending';
+    };
+    constant?: number;
+};
+export type ColorScaleOptions = ScaleOptions & {
+    legend: boolean;
+    type: ScaleType | 'categorical' | 'sequential' | 'cyclical' | 'threshold' | 'quantile' | 'quantize' | 'diverging' | 'diverging-log' | 'diverging-pow' | 'diverging-sqrt' | 'diverging-symlog';
+    scheme: string;
+    /**
+     * fallback color used for null/undefined
+     */
+    unknown: string;
+    /**
+     * center value for diverging scales
+     */
+    pivot: number;
+    /**
+     * number of colors for quantize and quantile-threshold scales
+     */
+    n: number;
+    interpolate: (d: any) => typeof d;
+    /**
+     * The tick format for the color scale legend.
+     */
+    tickFormat: false | Intl.NumberFormatOptions | ((d: RawValue) => string);
+};
+export type ScaleType = 'linear' | 'pow' | 'sqrt' | 'log' | 'symlog' | 'time' | 'point' | 'ordinal' | 'sequential' | 'band' | 'categorical' | 'cyclical' | 'threshold' | 'quantile-cont' | 'quantile' | 'quantize' | 'diverging' | 'diverging-log' | 'diverging-pow' | 'diverging-sqrt' | 'diverging-symlog';
+export type XScaleOptions = ScaleOptions & {
+    /**
+     * Activate the implicit GridX mark. For more control over the grid styling
+     * and layering, add an explicit GridX mark to your plot instead of using the
+     * implicit grids.
+     */
+    grid: boolean;
+    /**
+     * Controls the position of the implicit AxisX mark, or set to false to disable
+     * the implicit AxisX mark. For more control over the axis styling and layering
+     * add an explicit AxisX mark to your plot instead of using the implicit axes.
+     */
+    axis: AxisXAnchor | false;
+    /**
+     * rotate the axis ticks
+     */
+    tickRotate: number;
+    labelAnchor: 'auto' | 'left' | 'center' | 'right';
+    tickFormat: false | Intl.NumberFormatOptions | ((d: RawValue) => string);
+};
+export type YScaleOptions = ScaleOptions & {
+    /**
+     * Activate the implicit GridY mark. For more control over the grid styling
+     * and layering, add an explicit GridY mark to your plot instead of using the
+     * implicit grids.
+     */
+    grid: boolean;
+    /**
+     * Controls the position of the implicit AxisY mark, or set to false to disable
+     * the implicit AxisY mark. For more control over the axis styling and layering
+     * add an explicit AxisY mark to your plot instead of using the implicit axes.
+     */
+    axis: AxisYAnchor | false;
+    tickFormat: false | Intl.NumberFormatOptions | ((d: RawValue) => string);
+    /**
+     * rotate the axis ticks
+     */
+    tickRotate: number;
+    labelAnchor: 'auto' | 'bottom' | 'middle' | 'top';
+};
+export type LegendScaleOptions = ScaleOptions & {
+    legend: boolean;
+};
+export type PlotScale = {
+    type: ScaleType;
+    domain: RawValue[];
+    range: RawValue[];
+    autoTitle?: string;
+    /**
+     * The number of marks that are using this scale.
+     */
+    manualActiveMarks: number;
+    /**
+     * Set of accessors used in channels that are bound to this scale.
+     */
+    uniqueScaleProps: Set<ChannelAccessor>;
+    skip: Map<ScaledChannelName, Set<symbol>>;
+    fn: ScaleLinear<RawValue, number> & ScaleBand<RawValue> & ScaleOrdinal<string | Date, number> & ScaleOrdinal<string | Date, string>;
+};
+export type PlotScales = Record<ScaleName, PlotScale>;

package/dist/types/scale.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,126 +1,131 @@
 {
-  "name": "svelteplot",
-  "version": "0.3.4",
-  "license": "ISC",
-  "author": {
-    "name": "Gregor Aisch",
-    "email": "gka@users.noreply.github.com"
-  },
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "svelte": "./dist/index.js"
+    "name": "svelteplot",
+    "version": "0.3.5-pr-121.1",
+    "license": "ISC",
+    "author": {
+        "name": "Gregor Aisch",
+        "email": "gka@users.noreply.github.com"
     },
-    "./*.js": {
-      "import": "./dist/*.js"
+    "scripts": {
+        "dev": "vite dev",
+        "build": "vite build",
+        "preview": "vite preview",
+        "test": "npm run test:unit",
+        "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+        "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+        "lint": "prettier --check src && eslint src",
+        "format": "prettier --write .",
+        "test:unit": "vitest",
+        "prepack": "npx svelte-package",
+        "release-next": "npm version prerelease --preid next && npm publish && git push && git push --tags && sleep 1 && npm dist-tag add svelteplot@$(npm view . version) next",
+        "docs": "npm run build && cd build && rsync --recursive . vis4.net:svelteplot/alpha0/",
+        "screenshots": "node screenshot-examples.js"
     },
-    "./*.svelte": {
-      "import": "./dist/*.svelte"
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "svelte": "./dist/index.js"
+        },
+        "./*.js": {
+            "import": "./dist/*.js"
+        },
+        "./*.svelte": {
+            "import": "./dist/*.svelte"
+        },
+        "./core/*.svelte": {
+            "import": "./dist/core/*.svelte"
+        },
+        "./marks/*.svelte": {
+            "import": "./dist/marks/*.svelte"
+        },
+        "./transforms": {
+            "import": "./dist/transforms/index.js"
+        }
     },
-    "./core/*.svelte": {
-      "import": "./dist/core/*.svelte"
+    "main": "./dist/index.js",
+    "files": [
+        "dist",
+        "!dist/**/*.test.*",
+        "!dist/**/*.spec.*"
+    ],
+    "devDependencies": {
+        "@aitodotai/json-stringify-pretty-compact": "^1.3.0",
+        "@emotion/css": "^11.13.5",
+        "@sveltejs/adapter-auto": "^6.0.1",
+        "@sveltejs/adapter-static": "^3.0.8",
+        "@sveltejs/eslint-config": "^8.2.0",
+        "@sveltejs/kit": "^2.21.4",
+        "@sveltejs/package": "^2.3.11",
+        "@sveltejs/vite-plugin-svelte": "5.1.0",
+        "@sveltepress/theme-default": "^6.0.3",
+        "@sveltepress/twoslash": "^1.2.2",
+        "@sveltepress/vite": "^1.2.2",
+        "@testing-library/svelte": "^5.2.8",
+        "@testing-library/user-event": "^14.6.1",
+        "@types/d3-array": "^3.2.1",
+        "@types/d3-color": "^3.1.3",
+        "@types/d3-dsv": "^3.0.7",
+        "@types/d3-geo": "^3.1.0",
+        "@types/d3-interpolate": "^3.0.4",
+        "@types/d3-path": "^3.1.1",
+        "@types/d3-quadtree": "^3.0.6",
+        "@types/d3-random": "^3.0.3",
+        "@types/d3-scale": "^4.0.9",
+        "@types/d3-scale-chromatic": "^3.1.0",
+        "@types/d3-shape": "^3.1.7",
+        "@types/geojson": "^7946.0.16",
+        "@types/topojson": "^3.2.6",
+        "@types/topojson-client": "^3.1.5",
+        "@typescript-eslint/eslint-plugin": "^8.34.0",
+        "@typescript-eslint/parser": "^8.34.0",
+        "csstype": "^3.1.3",
+        "d3-dsv": "^3.0.1",
+        "d3-fetch": "^3.0.1",
+        "d3-force": "^3.0.0",
+        "eslint": "^9.28.0",
+        "eslint-config-prettier": "^10.1.5",
+        "eslint-plugin-svelte": "3.9.2",
+        "jsdom": "^26.1.0",
+        "prettier": "^3.5.3",
+        "prettier-plugin-svelte": "^3.4.0",
+        "puppeteer": "^24.10.0",
+        "remark-code-extra": "^1.0.1",
+        "remark-code-frontmatter": "^1.0.0",
+        "resize-observer-polyfill": "^1.5.1",
+        "sass": "^1.89.2",
+        "svelte-check": "^4.2.1",
+        "svelte-eslint-parser": "1.2.0",
+        "svelte-highlight": "^7.8.3",
+        "svg-path-parser": "^1.1.0",
+        "topojson-client": "^3.1.0",
+        "ts-essentials": "^10.1.0",
+        "tslib": "^2.8.1",
+        "typedoc": "^0.28.5",
+        "typedoc-plugin-markdown": "^4.6.4",
+        "typescript": "^5.8.3",
+        "vite": "^6.3.5",
+        "vitest": "^3.2.3",
+        "vitest-matchmedia-mock": "^2.0.3"
     },
-    "./marks/*.svelte": {
-      "import": "./dist/marks/*.svelte"
-    },
-    "./transforms": {
-      "import": "./dist/transforms/index.js"
+    "types": "./dist/index.d.ts",
+    "type": "module",
+    "dependencies": {
+        "d3-array": "^3.2.4",
+        "d3-color": "^3.1.0",
+        "d3-format": "^3.1.0",
+        "d3-geo": "^3.1.1",
+        "d3-interpolate": "^3.0.1",
+        "d3-path": "^3.1.0",
+        "d3-quadtree": "^3.0.1",
+        "d3-random": "^3.0.1",
+        "d3-regression": "^1.3.10",
+        "d3-scale": "^4.0.2",
+        "d3-scale-chromatic": "^3.1.0",
+        "d3-shape": "^3.2.0",
+        "d3-time": "^3.1.0",
+        "es-toolkit": "^1.39.3",
+        "fast-equals": "^5.2.2",
+        "merge-deep": "^3.0.3",
+        "svelte": "5.33.19"
     }
-  },
-  "main": "./dist/index.js",
-  "files": [
-    "dist",
-    "!dist/**/*.test.*",
-    "!dist/**/*.spec.*"
-  ],
-  "devDependencies": {
-    "@aitodotai/json-stringify-pretty-compact": "^1.3.0",
-    "@emotion/css": "^11.13.5",
-    "@sveltejs/adapter-auto": "^6.0.1",
-    "@sveltejs/adapter-static": "^3.0.8",
-    "@sveltejs/eslint-config": "^8.2.0",
-    "@sveltejs/kit": "^2.21.4",
-    "@sveltejs/package": "^2.3.11",
-    "@sveltejs/vite-plugin-svelte": "5.1.0",
-    "@sveltepress/theme-default": "^6.0.3",
-    "@sveltepress/twoslash": "^1.2.2",
-    "@sveltepress/vite": "^1.2.2",
-    "@testing-library/svelte": "^5.2.8",
-    "@testing-library/user-event": "^14.6.1",
-    "@types/d3-array": "^3.2.1",
-    "@types/d3-color": "^3.1.3",
-    "@types/d3-dsv": "^3.0.7",
-    "@types/d3-geo": "^3.1.0",
-    "@types/d3-interpolate": "^3.0.4",
-    "@types/d3-path": "^3.1.1",
-    "@types/d3-random": "^3.0.3",
-    "@types/d3-scale": "^4.0.9",
-    "@types/d3-scale-chromatic": "^3.1.0",
-    "@types/d3-shape": "^3.1.7",
-    "@typescript-eslint/eslint-plugin": "^8.34.0",
-    "@typescript-eslint/parser": "^8.34.0",
-    "csstype": "^3.1.3",
-    "d3-dsv": "^3.0.1",
-    "d3-fetch": "^3.0.1",
-    "d3-force": "^3.0.0",
-    "eslint": "^9.28.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-svelte": "3.9.2",
-    "jsdom": "^26.1.0",
-    "prettier": "^3.5.3",
-    "prettier-plugin-svelte": "^3.4.0",
-    "puppeteer": "^24.10.0",
-    "remark-code-extra": "^1.0.1",
-    "remark-code-frontmatter": "^1.0.0",
-    "resize-observer-polyfill": "^1.5.1",
-    "sass": "^1.89.2",
-    "svelte-check": "^4.2.1",
-    "svelte-eslint-parser": "1.2.0",
-    "svelte-highlight": "^7.8.3",
-    "svg-path-parser": "^1.1.0",
-    "topojson-client": "^3.1.0",
-    "ts-essentials": "^10.1.0",
-    "tslib": "^2.8.1",
-    "typedoc": "^0.28.5",
-    "typedoc-plugin-markdown": "^4.6.4",
-    "typescript": "^5.8.3",
-    "vite": "^6.3.5",
-    "vitest": "^3.2.3",
-    "vitest-matchmedia-mock": "^2.0.3"
-  },
-  "types": "./dist/index.d.ts",
-  "type": "module",
-  "dependencies": {
-    "d3-array": "^3.2.4",
-    "d3-color": "^3.1.0",
-    "d3-format": "^3.1.0",
-    "d3-geo": "^3.1.1",
-    "d3-interpolate": "^3.0.1",
-    "d3-path": "^3.1.0",
-    "d3-quadtree": "^3.0.1",
-    "d3-random": "^3.0.1",
-    "d3-regression": "^1.3.10",
-    "d3-scale": "^4.0.2",
-    "d3-scale-chromatic": "^3.1.0",
-    "d3-shape": "^3.2.0",
-    "d3-time": "^3.1.0",
-    "es-toolkit": "^1.39.3",
-    "fast-equals": "^5.2.2",
-    "merge-deep": "^3.0.3",
-    "svelte": "5.33.19"
-  },
-  "scripts": {
-    "dev": "vite dev",
-    "build": "vite build",
-    "preview": "vite preview",
-    "test": "npm run test:unit",
-    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
-    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
-    "lint": "prettier --check src && eslint src",
-    "format": "prettier --write .",
-    "test:unit": "vitest",
-    "release-next": "npm version prerelease --preid next && npm publish && git push && git push --tags && sleep 1 && npm dist-tag add svelteplot@$(npm view . version) next",
-    "docs": "npm run build && cd build && rsync --recursive . vis4.net:svelteplot/alpha0/",
-    "screenshots": "node screenshot-examples.js"
-  }
-}
+}