feat: simplify custom marks #131
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for svelteplot ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
📦 Preview package for this PR is published! Version: Install it with: npm install svelteplot@pr-131
# or install the specific version
npm install svelteplot@0.3.7-pr-131.0 |
|
📦 Preview package for this PR is published! Version: Install it with: npm install svelteplot@pr-131
# or install the specific version
npm install svelteplot@0.3.7-pr-131.1 |
|
📦 Preview package for this PR is published! Version: Install it with: npm install svelteplot@pr-131
# or install the specific version
npm install svelteplot@0.3.7-pr-131.2 |
|
📦 Preview package for this PR is published! Version: Install it with: npm install svelteplot@pr-131
# or install the specific version
npm install svelteplot@0.3.7-pr-131.3 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a major overhaul of the
CustomMarkAPI in SveltePlot, making it more flexible and powerful for rendering custom SVG marks. The new API allows users to access all scaled channel values, provides both per-record and batch rendering options, and adds support for new channels. The documentation and examples have been updated to reflect these changes.CustomMark API Enhancements:
CustomMarkcomponent now accepts any combination of channel accessors (x,y,x1,x2,y1,y2,r,fill,stroke, etc.) and exposes all scaled values to the user via therecordobject in snippets. It supports bothmark(per-record) andmarks(batch) rendering snippets, and thedataprop is now optional. (src/lib/marks/CustomMark.svelte, src/lib/marks/CustomMark.svelteL7-R69)ScaledDataRecordtype was refactored to use the newScaledChannelTypeutility, ensuring type safety for all channel values. (src/lib/types/data.ts, src/lib/types/data.tsL15-R17)MarkTypeenum now includes'custom'to support the new mark type. (src/lib/types/mark.ts, src/lib/types/mark.tsR16)Markcomponent and related types were updated to support the new, genericScaledDataRecord<Datum>. (src/lib/Mark.svelte, [1];src/lib/types/channel.ts, [2]Documentation and Example Updates:
/marks/customdocumentation page was rewritten to explain the new API, show usage of bothmarkandmarkssnippets, and remove outdated examples such asmapXY. (src/routes/marks/custom/+page.md, [1] [2] [3]custom-rect.sveltefor drawing rectangles with custom channels.single.sveltefor single mark placement.custom-svg.sveltetomultiple.svelteto show multi-mark SVG usage with the new API. [1] [2] [3]Type and Internal Improvements:
ScaledChannelTypeutility type to ensure channel values are correctly typed (string or number as appropriate). (src/lib/types/channel.ts, [1];src/lib/types/data.ts, [2]CustomMarkcomponent now dynamically determines which channels are required based on provided props, improving flexibility and reducing boilerplate. (src/lib/marks/CustomMark.svelte, src/lib/marks/CustomMark.svelteL7-R69)These changes make it much easier to create custom visualizations in SveltePlot, with a more consistent and extensible API.