Skip to content

Optimize marker rendering and support custom markers #7653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gatopeich wants to merge 23 commits into
base: master
Choose a base branch
from
Open

Optimize marker rendering and support custom markers #7653

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2d44177
Initial plan
Copilot Nov 19, 2025
8310635
Add addCustomMarker API for registering custom SVG markers
Copilot Nov 19, 2025
343dd6c
Add demo file for custom marker feature
Copilot Nov 19, 2025
90c697a
Add comprehensive documentation for custom marker API
Copilot Nov 19, 2025
547b0b7
Add implementation summary document
Copilot Nov 19, 2025
86086e0
Simplify API: allow passing custom functions directly as marker.symbol
Copilot Nov 21, 2025
099b0d6
Check if symbol is function before calling symbolNumber() in backoff …
Copilot Nov 22, 2025
42ab66d
Simplify function check in backoff calculation
Copilot Nov 22, 2025
d8739bd
Merge pull request #1 from gatopeich/copilot/add-custom-svg-markers
gatopeich Nov 22, 2025
398d1d4
Merge branch 'plotly:master' into master
gatopeich Nov 22, 2025
db38309
Add change draft log entry
gatopeich Nov 22, 2025
0cc49cc
Pass customdata to custom marker functions (backward compatible) (#2)
Copilot Jan 18, 2026
c055d26
Fix test assertions for custom marker function call counts
gatopeich Jan 19, 2026
ce14c7e
Tighten test assertions: expect exactly 3 or 6 marker function calls
ap-viavi Jan 20, 2026
fd70889
Add consolidated demo: all_demos.html
ap-viavi Jan 20, 2026
2c1110b
Fix CI: rename docs to lowercase, skip non-symbol exports in schema
gatopeich Jan 23, 2026
71ca7a9
Merge branch 'plotly:master' into master
gatopeich Feb 12, 2026
e073716
Fix brittle test assertions in custom marker function tests (#6)
Claude Feb 13, 2026
cef92be
Merge branch 'plotly:master' into master
gatopeich Feb 24, 2026
3026a1e
Optimize marker render pipeline via SVG `<symbol>`/`<use>` (#7)
Copilot Mar 22, 2026
6bbdb63
Restore dist files deleted by PR #7 (#9)
Copilot Mar 22, 2026
c74c81d
Remove coerce.js function pass-through hack; fatal errors on unknown …
Copilot Mar 22, 2026
5d2add8
Address PR #7653 review comments: restore symDef.n, rename/clean demo…
Copilot Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove coerce.js function pass-through hack; fatal errors on unknown … 
…marker symbols (#11)

* Initial plan

* Remove coerce.js function pass-through fix and raise fatal errors on unknown marker symbols

Co-authored-by: gatopeich <7722268+gatopeich@users.noreply.github.com>
Agent-Logs-Url: https://github.com/gatopeich/plotly.js/sessions/faf05e5d-fbbf-4670-97b3-f5ee6a9ec6a0

* Move error throwing inside lookupSymbol for better encapsulation

Co-authored-by: gatopeich <7722268+gatopeich@users.noreply.github.com>
Agent-Logs-Url: https://github.com/gatopeich/plotly.js/sessions/702780b7-60c8-481e-9550-f292fc6482c8

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: gatopeich <7722268+gatopeich@users.noreply.github.com>
  • Loading branch information
@gatopeich
Copilot and gatopeich authored Mar 22, 2026
commit c74c81d766c4e6516727f0aea8f2c006b6cfe91c
23 changes: 13 additions & 10 deletions src/components/drawing/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ for(var _i = 0; _i < MAXSYMBOL; _i++) {
* n = idx + (open ? 100 : 0) + (dot ? 200 : 0)
* so lookupSymbol(100).n === 100, lookupSymbol('circle-open').n === 100, etc.
* n is null for custom SVG paths (id assigned per-SVG by ensureSymbolDef).
* Returns null for unrecognised input (callers should fall back to circle).
* Throws an Error for unrecognised input.
*/
drawing.lookupSymbol = function (v) {
// Raw SVG path — no deterministic n; ensureSymbolDef will assign a per-SVG id.
Expand All @@ -418,20 +418,20 @@ drawing.lookupSymbol = function (v) {
var name, open = false, dot = false, idx;
if (isNumeric(v)) {
var n = Math.floor(Math.max(+v, 0));
if (n >= 400) return null;
if (n >= 400) throw new Error('Unknown marker symbol: ' + v);
open = n % 200 >= 100;
Copy link
Copy Markdown
Author

@gatopeich gatopeich Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is the special handling for open versions? Can it apply to custom symbols?
Can we specify openness in the path string instead of special handling?

dot = n >= 200;
idx = n % 100;
if (idx >= MAXSYMBOL) return null;
if (idx >= MAXSYMBOL) throw new Error('Unknown marker symbol: ' + v);
name = drawing.symbolNames[idx];
} else if (typeof v === 'string') {
if (v.indexOf('-open') > 0) { open = true; v = v.replace('-open', ''); }
if (v.indexOf('-dot') > 0) { dot = true; v = v.replace('-dot', ''); }
idx = drawing.symbolNames.indexOf(v);
if (idx < 0) return null;
if (idx < 0) throw new Error('Unknown marker symbol: ' + v);
name = v;
} else {
return null;
throw new Error('Unknown marker symbol: ' + v);
}

var symN = idx + (open ? 100 : 0) + (dot ? 200 : 0);
Expand All @@ -449,9 +449,7 @@ drawing.lookupSymbol = function (v) {

// sym.n already equals the legacy numeric encoding, so symbolNumber is a simple wrapper.
drawing.symbolNumber = function (v) {
var sym = drawing.lookupSymbol(v);
if (!sym || !sym.name) return 0;
return sym.n;
return drawing.lookupSymbol(v).n;
};

drawing.ensureSymbolDef = function (gd, sym) {
Expand Down Expand Up @@ -1000,7 +998,7 @@ drawing.singlePointStyle = function (d, sel, trace, fns, gd, pt) {
}

var symbolValue = d.mx || marker.symbol;
var sym = drawing.lookupSymbol(symbolValue) || drawing.lookupSymbol(0);
var sym = drawing.lookupSymbol(symbolValue);

// save if this marker is open (impacts color handling)
d.om = sym.open;
Expand Down Expand Up @@ -1605,7 +1603,12 @@ function applyBackoff(pt, start) {
var endMarkerSize = endMarker.size;
if (Lib.isArrayOrTypedArray(endMarkerSize)) endMarkerSize = endMarkerSize[endI];

b = endMarker ? ((drawing.lookupSymbol(endMarkerSymbol) || {}).backoff || 0) * endMarkerSize : 0;
if(endMarker) {
var endMarkerSym = drawing.lookupSymbol(endMarkerSymbol);
b = (endMarkerSym.backoff || 0) * endMarkerSize;
} else {
b = 0;
}
b += drawing.getMarkerStandoff(d[endI], trace) || 0;
}

Expand Down
5 changes: 0 additions & 5 deletions src/lib/coerce.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,6 @@ exports.valObjectMeta = {
requiredOpts: ['values'],
otherOpts: ['dflt', 'coerceNumber', 'arrayOk'],
coerceFunction: function(v, propOut, dflt, opts) {
// Allow functions to pass through (for custom marker symbols, etc.)
if(typeof v === 'function') {
propOut.set(v);
return;
}
if(opts.coerceNumber) v = +v;
if(opts.values.indexOf(v) === -1) propOut.set(dflt);
else propOut.set(v);
Expand Down