categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

Closed
my-tien wants to merge 3 commits into from
Closed

categoryshapeshiftstart and categoryshapeshiftend properties for category axes #7010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
508f725
categoryshapeshiftstart and categoryshapeshiftend properties for cate…
my-tien Jun 3, 2024
241f31c
Fix shapeBounds calculation
my-tien Jun 3, 2024
b087493
Baseline images for shape_shift_horizontal and shape_shift_vertical
my-tien Jun 3, 2024
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
42 changes: 31 additions & 11 deletions src/components/shapes/calc_autorange.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

// paper and axis domain referenced shapes don't affect autorange
if(shape.xref !== 'paper' && xRefType !== 'domain') {
var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
ax = Axes.getFromId(gd, shape.xref);

bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
bounds = shapeBounds(ax, shape, constants.paramIsX, false);

@archmojarchmojJun 4, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change
bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);

if(bounds) {
shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
}
}

if(shape.yref !== 'paper' && yRefType !== 'domain') {
var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
ax = Axes.getFromId(gd, shape.yref);

bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
bounds = shapeBounds(ax, shape, constants.paramIsY, true);

@archmojarchmojJun 4, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change
bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);

if(bounds) {
shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
}
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
}
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {

@archmojarchmojJun 4, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.

 var isY = axi._id.charAt(0) === 'y';

var v0;
var v1;
var shiftStart = 0;
var shiftEnd = 0;
if(isVerticalAxis) {
var isYSizeModePixel = shape.ysizemode === 'pixel';
v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
} else {
var isXSizeModePixel = shape.xsizemode === 'pixel';
v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
}

var convertVal;

if(ax.type === 'category' || ax.type === 'multicategory') {
convertVal = ax.r2c;
if(shape.xsizemode === 'scale') {
shiftStart = ax.categoryshapeshiftstart;
shiftEnd = ax.categoryshapeshiftend;
}
} else {
convertVal = ax.d2c;
}

if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
if(!path) return;
if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
if(!shape.path) return;

var min = Infinity;
var max = -Infinity;
var segments = path.match(constants.segmentRE);
var segments = shape.path.match(constants.segmentRE);
var i;
var segment;
var drawnParam;
Expand Down
22 changes: 16 additions & 6 deletions src/components/shapes/display_labels.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
// and convert them to pixel coordinates
// Setup conversion functions
var xa = Axes.getFromId(gd, options.xref);
var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
var xRefType = Axes.getRefType(options.xref);
var ya = Axes.getFromId(gd, options.yref);
var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
var yRefType = Axes.getRefType(options.yref);
var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
shapex0 = x2p(options.x0);
shapex1 = x2p(options.x1);
shapey0 = y2p(options.y0);
shapey1 = y2p(options.y1);
var x2p = function(v, shift) {
var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
return dataToPixel(v);
};
var y2p = function(v, shift) {
var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
return dataToPixel(v);
};
shapex0 = x2p(options.x0, xShiftStart);
shapex1 = x2p(options.x1, xShiftEnd);
shapey0 = y2p(options.y0, yShiftStart);
shapey1 = y2p(options.y1, yShiftEnd);
}

// Handle `auto` angle
Expand Down
22 changes: 16 additions & 6 deletions src/components/shapes/draw.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
var xRefType = Axes.getRefType(shapeOptions.xref);
var ya = Axes.getFromId(gd, shapeOptions.yref);
var yRefType = Axes.getRefType(shapeOptions.yref);
var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
var x2p = function(v, shift) {
var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
return dataToPixel(v);
};
var y2p = function(v, shift) {
var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
return dataToPixel(v);
};
var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
g.append('circle')
.attr({
'data-line-point': 'start-point',
cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
r: circleRadius
})
.style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
g.append('circle')
.attr({
'data-line-point': 'end-point',
cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
r: circleRadius
})
.style(circleStyle)
Expand Down
42 changes: 32 additions & 10 deletions src/components/shapes/helpers.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
var gs = gd._fullLayout._size;
var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
var d2r = exports.shapePositionToRange(axis);

dataToPixel = function(v) {
return axis._offset + axis.r2p(d2r(v, true));
var shiftPixels = 0;
if(axis.type === 'category' || axis.type === 'multicategory') {
if(isVertical) {
shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
} else {
shiftPixels = axis.r2p(0.5) * shift;
}
}
return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
};

if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
var ya = Axes.getFromId(gd, options.yref);
var gs = gd._fullLayout._size;
var x2r, x2p, y2r, y2p;
var xShiftStart = 0;
var xShiftEnd = 0;
var yShiftStart = 0;
var yShiftEnd = 0;
var x0, x1, y0, y1;

if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
} else {
x2r = exports.shapePositionToRange(xa);
x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
if(xa.type === 'category' || xa.type === 'multicategory') {
var shiftUnitX = xa.r2p(0.5);
xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
}
}
} else {
x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
} else {
y2r = exports.shapePositionToRange(ya);
y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
if(ya.type === 'category' || ya.type === 'multicategory') {
var shiftUnitY = ya.r2p(0) - ya.r2p(1);
yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
}
}
} else {
y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

if(options.xsizemode === 'pixel') {
var xAnchorPos = x2p(options.xanchor);
x0 = xAnchorPos + options.x0;
x1 = xAnchorPos + options.x1;
x0 = xAnchorPos + options.x0 + xShiftStart;
x1 = xAnchorPos + options.x1 + xShiftEnd;
} else {
x0 = x2p(options.x0);
x1 = x2p(options.x1);
x0 = x2p(options.x0) + xShiftStart;
x1 = x2p(options.x1) + xShiftEnd;
}

if(options.ysizemode === 'pixel') {
var yAnchorPos = y2p(options.yanchor);
y0 = yAnchorPos - options.y0;
y1 = yAnchorPos - options.y1;
y0 = yAnchorPos - options.y0 - yShiftStart;
y1 = yAnchorPos - options.y1 - yShiftEnd;
} else {
y0 = y2p(options.y0);
y1 = y2p(options.y1);
y0 = y2p(options.y0) - yShiftStart;
y1 = y2p(options.y1) - yShiftEnd;
}

if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down
5 changes: 5 additions & 0 deletions src/plots/cartesian/axis_defaults.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

if(axType === 'category' || axType === 'multicategory') {
containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
}

if(axType !== 'category' && !options.noHover) coerce('hoverformat');

var dfltColor = coerce('color');
Expand Down
22 changes: 22 additions & 0 deletions src/plots/cartesian/layout_attributes.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
'Used with `categoryorder`.'
].join(' ')
},
categoryshapeshiftstart: {
valType: 'number',
dflt: 0,
min: -0.5,
max: 0.5,

@archmojarchmojJun 4, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.
I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?

editType: 'calc',
description: [
'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
'reference unit.'
]

@archmojarchmojJun 4, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
]
].join(' ')

},
categoryshapeshiftend: {
valType: 'number',
dflt: 0,
min: -0.5,
max: 0.5,
editType: 'calc',
description: [
'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
'reference unit.'
]

@archmojarchmojJun 4, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
]
].join(' ')

},
uirevision: {
valType: 'any',
editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

 Closed

my-tien
wants to merge
3
commits into

from

 Closed


categoryshapeshiftstart and categoryshapeshiftend properties for category axes
#7010
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
508f725

categoryshapeshiftstart and categoryshapeshiftend properties for cate…


my-tien Jun 3, 2024
241f31c

Fix shapeBounds calculation


my-tien Jun 3, 2024
b087493

Baseline images for shape_shift_horizontal and shape_shift_vertical


my-tien Jun 3, 2024

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


42 changes: 31 additions & 11 deletions
src/components/shapes/calc_autorange.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

 // paper and axis domain referenced shapes don't affect autorange
 if(shape.xref !== 'paper' && xRefType !== 'domain') {
 var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
 var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
 ax = Axes.getFromId(gd, shape.xref);

 bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
 bounds = shapeBounds(ax, shape, constants.paramIsX, false);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
 }
 }

 if(shape.yref !== 'paper' && yRefType !== 'domain') {
 var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
 var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
 ax = Axes.getFromId(gd, shape.yref);

 bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
 bounds = shapeBounds(ax, shape, constants.paramIsY, true);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
 }
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
 }
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
 var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.
 var isY = axi._id.charAt(0) === 'y';

 var v0;
 var v1;
 var shiftStart = 0;
 var shiftEnd = 0;
 if(isVerticalAxis) {
 var isYSizeModePixel = shape.ysizemode === 'pixel';
 v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
 v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
 } else {
 var isXSizeModePixel = shape.xsizemode === 'pixel';
 v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
 v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
 }

 var convertVal;

 if(ax.type === 'category' || ax.type === 'multicategory') {
 convertVal = ax.r2c;
 if(shape.xsizemode === 'scale') {
 shiftStart = ax.categoryshapeshiftstart;
 shiftEnd = ax.categoryshapeshiftend;
 }
 } else {
 convertVal = ax.d2c;
 }

 if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
 if(!path) return;
 if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
 if(!shape.path) return;

 var min = Infinity;
 var max = -Infinity;
 var segments = path.match(constants.segmentRE);
 var segments = shape.path.match(constants.segmentRE);
 var i;
 var segment;
 var drawnParam;
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/display_labels.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
 // and convert them to pixel coordinates
 // Setup conversion functions
 var xa = Axes.getFromId(gd, options.xref);
 var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
 var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
 var xRefType = Axes.getRefType(options.xref);
 var ya = Axes.getFromId(gd, options.yref);
 var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
 var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
 var yRefType = Axes.getRefType(options.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 shapex0 = x2p(options.x0);
 shapex1 = x2p(options.x1);
 shapey0 = y2p(options.y0);
 shapey1 = y2p(options.y1);
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 shapex0 = x2p(options.x0, xShiftStart);
 shapex1 = x2p(options.x1, xShiftEnd);
 shapey0 = y2p(options.y0, yShiftStart);
 shapey1 = y2p(options.y1, yShiftEnd);
 }

 // Handle `auto` angle
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 var xRefType = Axes.getRefType(shapeOptions.xref);
 var ya = Axes.getFromId(gd, shapeOptions.yref);
 var yRefType = Axes.getRefType(shapeOptions.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
 var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
 var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
 var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
 var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'start-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
 r: circleRadius
 })
 .style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'end-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
 r: circleRadius
 })
 .style(circleStyle)
Expand Down

42 changes: 32 additions & 10 deletions
src/components/shapes/helpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
 return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
 var gs = gd._fullLayout._size;
 var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
 var d2r = exports.shapePositionToRange(axis);

 dataToPixel = function(v) {
 return axis._offset + axis.r2p(d2r(v, true));
 var shiftPixels = 0;
 if(axis.type === 'category' || axis.type === 'multicategory') {
 if(isVertical) {
 shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
 } else {
 shiftPixels = axis.r2p(0.5) * shift;
 }
 }
 return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
 };

 if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
 var ya = Axes.getFromId(gd, options.yref);
 var gs = gd._fullLayout._size;
 var x2r, x2p, y2r, y2p;
 var xShiftStart = 0;
 var xShiftEnd = 0;
 var yShiftStart = 0;
 var yShiftEnd = 0;
 var x0, x1, y0, y1;

 if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
 } else {
 x2r = exports.shapePositionToRange(xa);
 x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
 if(xa.type === 'category' || xa.type === 'multicategory') {
 var shiftUnitX = xa.r2p(0.5);
 xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
 xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
 }
 }
 } else {
 x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
 } else {
 y2r = exports.shapePositionToRange(ya);
 y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
 if(ya.type === 'category' || ya.type === 'multicategory') {
 var shiftUnitY = ya.r2p(0) - ya.r2p(1);
 yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
 yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
 }
 }
 } else {
 y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

 if(options.xsizemode === 'pixel') {
 var xAnchorPos = x2p(options.xanchor);
 x0 = xAnchorPos + options.x0;
 x1 = xAnchorPos + options.x1;
 x0 = xAnchorPos + options.x0 + xShiftStart;
 x1 = xAnchorPos + options.x1 + xShiftEnd;
 } else {
 x0 = x2p(options.x0);
 x1 = x2p(options.x1);
 x0 = x2p(options.x0) + xShiftStart;
 x1 = x2p(options.x1) + xShiftEnd;
 }

 if(options.ysizemode === 'pixel') {
 var yAnchorPos = y2p(options.yanchor);
 y0 = yAnchorPos - options.y0;
 y1 = yAnchorPos - options.y1;
 y0 = yAnchorPos - options.y0 - yShiftStart;
 y1 = yAnchorPos - options.y1 - yShiftEnd;
 } else {
 y0 = y2p(options.y0);
 y1 = y2p(options.y1);
 y0 = y2p(options.y0) - yShiftStart;
 y1 = y2p(options.y1) - yShiftEnd;
 }

 if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down

5 changes: 5 additions & 0 deletions
src/plots/cartesian/axis_defaults.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

 handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

 if(axType === 'category' || axType === 'multicategory') {
 containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
 containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
 }

 if(axType !== 'category' && !options.noHover) coerce('hoverformat');

 var dfltColor = coerce('color');
Expand Down

22 changes: 22 additions & 0 deletions
src/plots/cartesian/layout_attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
 'Used with `categoryorder`.'
 ].join(' ')
 },
 categoryshapeshiftstart: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.

I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 categoryshapeshiftend: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 uirevision: {
 valType: 'any',
 editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

 Closed

my-tien
wants to merge
3
commits into

from

 Closed


categoryshapeshiftstart and categoryshapeshiftend properties for category axes
#7010
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
508f725

categoryshapeshiftstart and categoryshapeshiftend properties for cate…


my-tien Jun 3, 2024
241f31c

Fix shapeBounds calculation


my-tien Jun 3, 2024
b087493

Baseline images for shape_shift_horizontal and shape_shift_vertical


my-tien Jun 3, 2024

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


42 changes: 31 additions & 11 deletions
src/components/shapes/calc_autorange.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

 // paper and axis domain referenced shapes don't affect autorange
 if(shape.xref !== 'paper' && xRefType !== 'domain') {
 var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
 var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
 ax = Axes.getFromId(gd, shape.xref);

 bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
 bounds = shapeBounds(ax, shape, constants.paramIsX, false);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
 }
 }

 if(shape.yref !== 'paper' && yRefType !== 'domain') {
 var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
 var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
 ax = Axes.getFromId(gd, shape.yref);

 bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
 bounds = shapeBounds(ax, shape, constants.paramIsY, true);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
 }
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
 }
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
 var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.
 var isY = axi._id.charAt(0) === 'y';

 var v0;
 var v1;
 var shiftStart = 0;
 var shiftEnd = 0;
 if(isVerticalAxis) {
 var isYSizeModePixel = shape.ysizemode === 'pixel';
 v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
 v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
 } else {
 var isXSizeModePixel = shape.xsizemode === 'pixel';
 v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
 v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
 }

 var convertVal;

 if(ax.type === 'category' || ax.type === 'multicategory') {
 convertVal = ax.r2c;
 if(shape.xsizemode === 'scale') {
 shiftStart = ax.categoryshapeshiftstart;
 shiftEnd = ax.categoryshapeshiftend;
 }
 } else {
 convertVal = ax.d2c;
 }

 if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
 if(!path) return;
 if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
 if(!shape.path) return;

 var min = Infinity;
 var max = -Infinity;
 var segments = path.match(constants.segmentRE);
 var segments = shape.path.match(constants.segmentRE);
 var i;
 var segment;
 var drawnParam;
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/display_labels.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
 // and convert them to pixel coordinates
 // Setup conversion functions
 var xa = Axes.getFromId(gd, options.xref);
 var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
 var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
 var xRefType = Axes.getRefType(options.xref);
 var ya = Axes.getFromId(gd, options.yref);
 var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
 var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
 var yRefType = Axes.getRefType(options.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 shapex0 = x2p(options.x0);
 shapex1 = x2p(options.x1);
 shapey0 = y2p(options.y0);
 shapey1 = y2p(options.y1);
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 shapex0 = x2p(options.x0, xShiftStart);
 shapex1 = x2p(options.x1, xShiftEnd);
 shapey0 = y2p(options.y0, yShiftStart);
 shapey1 = y2p(options.y1, yShiftEnd);
 }

 // Handle `auto` angle
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 var xRefType = Axes.getRefType(shapeOptions.xref);
 var ya = Axes.getFromId(gd, shapeOptions.yref);
 var yRefType = Axes.getRefType(shapeOptions.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
 var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
 var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
 var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
 var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'start-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
 r: circleRadius
 })
 .style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'end-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
 r: circleRadius
 })
 .style(circleStyle)
Expand Down

42 changes: 32 additions & 10 deletions
src/components/shapes/helpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
 return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
 var gs = gd._fullLayout._size;
 var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
 var d2r = exports.shapePositionToRange(axis);

 dataToPixel = function(v) {
 return axis._offset + axis.r2p(d2r(v, true));
 var shiftPixels = 0;
 if(axis.type === 'category' || axis.type === 'multicategory') {
 if(isVertical) {
 shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
 } else {
 shiftPixels = axis.r2p(0.5) * shift;
 }
 }
 return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
 };

 if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
 var ya = Axes.getFromId(gd, options.yref);
 var gs = gd._fullLayout._size;
 var x2r, x2p, y2r, y2p;
 var xShiftStart = 0;
 var xShiftEnd = 0;
 var yShiftStart = 0;
 var yShiftEnd = 0;
 var x0, x1, y0, y1;

 if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
 } else {
 x2r = exports.shapePositionToRange(xa);
 x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
 if(xa.type === 'category' || xa.type === 'multicategory') {
 var shiftUnitX = xa.r2p(0.5);
 xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
 xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
 }
 }
 } else {
 x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
 } else {
 y2r = exports.shapePositionToRange(ya);
 y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
 if(ya.type === 'category' || ya.type === 'multicategory') {
 var shiftUnitY = ya.r2p(0) - ya.r2p(1);
 yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
 yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
 }
 }
 } else {
 y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

 if(options.xsizemode === 'pixel') {
 var xAnchorPos = x2p(options.xanchor);
 x0 = xAnchorPos + options.x0;
 x1 = xAnchorPos + options.x1;
 x0 = xAnchorPos + options.x0 + xShiftStart;
 x1 = xAnchorPos + options.x1 + xShiftEnd;
 } else {
 x0 = x2p(options.x0);
 x1 = x2p(options.x1);
 x0 = x2p(options.x0) + xShiftStart;
 x1 = x2p(options.x1) + xShiftEnd;
 }

 if(options.ysizemode === 'pixel') {
 var yAnchorPos = y2p(options.yanchor);
 y0 = yAnchorPos - options.y0;
 y1 = yAnchorPos - options.y1;
 y0 = yAnchorPos - options.y0 - yShiftStart;
 y1 = yAnchorPos - options.y1 - yShiftEnd;
 } else {
 y0 = y2p(options.y0);
 y1 = y2p(options.y1);
 y0 = y2p(options.y0) - yShiftStart;
 y1 = y2p(options.y1) - yShiftEnd;
 }

 if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down

5 changes: 5 additions & 0 deletions
src/plots/cartesian/axis_defaults.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

 handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

 if(axType === 'category' || axType === 'multicategory') {
 containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
 containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
 }

 if(axType !== 'category' && !options.noHover) coerce('hoverformat');

 var dfltColor = coerce('color');
Expand Down

22 changes: 22 additions & 0 deletions
src/plots/cartesian/layout_attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
 'Used with `categoryorder`.'
 ].join(' ')
 },
 categoryshapeshiftstart: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.

I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 categoryshapeshiftend: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 uirevision: {
 valType: 'any',
 editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

 Closed

my-tien
wants to merge
3
commits into

from

 Closed


categoryshapeshiftstart and categoryshapeshiftend properties for category axes
#7010
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
508f725

categoryshapeshiftstart and categoryshapeshiftend properties for cate…


my-tien Jun 3, 2024
241f31c

Fix shapeBounds calculation


my-tien Jun 3, 2024
b087493

Baseline images for shape_shift_horizontal and shape_shift_vertical


my-tien Jun 3, 2024

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


42 changes: 31 additions & 11 deletions
src/components/shapes/calc_autorange.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

 // paper and axis domain referenced shapes don't affect autorange
 if(shape.xref !== 'paper' && xRefType !== 'domain') {
 var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
 var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
 ax = Axes.getFromId(gd, shape.xref);

 bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
 bounds = shapeBounds(ax, shape, constants.paramIsX, false);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
 }
 }

 if(shape.yref !== 'paper' && yRefType !== 'domain') {
 var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
 var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
 ax = Axes.getFromId(gd, shape.yref);

 bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
 bounds = shapeBounds(ax, shape, constants.paramIsY, true);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
 }
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
 }
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
 var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.
 var isY = axi._id.charAt(0) === 'y';

 var v0;
 var v1;
 var shiftStart = 0;
 var shiftEnd = 0;
 if(isVerticalAxis) {
 var isYSizeModePixel = shape.ysizemode === 'pixel';
 v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
 v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
 } else {
 var isXSizeModePixel = shape.xsizemode === 'pixel';
 v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
 v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
 }

 var convertVal;

 if(ax.type === 'category' || ax.type === 'multicategory') {
 convertVal = ax.r2c;
 if(shape.xsizemode === 'scale') {
 shiftStart = ax.categoryshapeshiftstart;
 shiftEnd = ax.categoryshapeshiftend;
 }
 } else {
 convertVal = ax.d2c;
 }

 if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
 if(!path) return;
 if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
 if(!shape.path) return;

 var min = Infinity;
 var max = -Infinity;
 var segments = path.match(constants.segmentRE);
 var segments = shape.path.match(constants.segmentRE);
 var i;
 var segment;
 var drawnParam;
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/display_labels.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
 // and convert them to pixel coordinates
 // Setup conversion functions
 var xa = Axes.getFromId(gd, options.xref);
 var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
 var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
 var xRefType = Axes.getRefType(options.xref);
 var ya = Axes.getFromId(gd, options.yref);
 var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
 var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
 var yRefType = Axes.getRefType(options.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 shapex0 = x2p(options.x0);
 shapex1 = x2p(options.x1);
 shapey0 = y2p(options.y0);
 shapey1 = y2p(options.y1);
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 shapex0 = x2p(options.x0, xShiftStart);
 shapex1 = x2p(options.x1, xShiftEnd);
 shapey0 = y2p(options.y0, yShiftStart);
 shapey1 = y2p(options.y1, yShiftEnd);
 }

 // Handle `auto` angle
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 var xRefType = Axes.getRefType(shapeOptions.xref);
 var ya = Axes.getFromId(gd, shapeOptions.yref);
 var yRefType = Axes.getRefType(shapeOptions.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
 var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
 var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
 var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
 var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'start-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
 r: circleRadius
 })
 .style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'end-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
 r: circleRadius
 })
 .style(circleStyle)
Expand Down

42 changes: 32 additions & 10 deletions
src/components/shapes/helpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
 return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
 var gs = gd._fullLayout._size;
 var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
 var d2r = exports.shapePositionToRange(axis);

 dataToPixel = function(v) {
 return axis._offset + axis.r2p(d2r(v, true));
 var shiftPixels = 0;
 if(axis.type === 'category' || axis.type === 'multicategory') {
 if(isVertical) {
 shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
 } else {
 shiftPixels = axis.r2p(0.5) * shift;
 }
 }
 return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
 };

 if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
 var ya = Axes.getFromId(gd, options.yref);
 var gs = gd._fullLayout._size;
 var x2r, x2p, y2r, y2p;
 var xShiftStart = 0;
 var xShiftEnd = 0;
 var yShiftStart = 0;
 var yShiftEnd = 0;
 var x0, x1, y0, y1;

 if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
 } else {
 x2r = exports.shapePositionToRange(xa);
 x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
 if(xa.type === 'category' || xa.type === 'multicategory') {
 var shiftUnitX = xa.r2p(0.5);
 xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
 xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
 }
 }
 } else {
 x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
 } else {
 y2r = exports.shapePositionToRange(ya);
 y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
 if(ya.type === 'category' || ya.type === 'multicategory') {
 var shiftUnitY = ya.r2p(0) - ya.r2p(1);
 yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
 yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
 }
 }
 } else {
 y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

 if(options.xsizemode === 'pixel') {
 var xAnchorPos = x2p(options.xanchor);
 x0 = xAnchorPos + options.x0;
 x1 = xAnchorPos + options.x1;
 x0 = xAnchorPos + options.x0 + xShiftStart;
 x1 = xAnchorPos + options.x1 + xShiftEnd;
 } else {
 x0 = x2p(options.x0);
 x1 = x2p(options.x1);
 x0 = x2p(options.x0) + xShiftStart;
 x1 = x2p(options.x1) + xShiftEnd;
 }

 if(options.ysizemode === 'pixel') {
 var yAnchorPos = y2p(options.yanchor);
 y0 = yAnchorPos - options.y0;
 y1 = yAnchorPos - options.y1;
 y0 = yAnchorPos - options.y0 - yShiftStart;
 y1 = yAnchorPos - options.y1 - yShiftEnd;
 } else {
 y0 = y2p(options.y0);
 y1 = y2p(options.y1);
 y0 = y2p(options.y0) - yShiftStart;
 y1 = y2p(options.y1) - yShiftEnd;
 }

 if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down

5 changes: 5 additions & 0 deletions
src/plots/cartesian/axis_defaults.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

 handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

 if(axType === 'category' || axType === 'multicategory') {
 containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
 containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
 }

 if(axType !== 'category' && !options.noHover) coerce('hoverformat');

 var dfltColor = coerce('color');
Expand Down

22 changes: 22 additions & 0 deletions
src/plots/cartesian/layout_attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
 'Used with `categoryorder`.'
 ].join(' ')
 },
 categoryshapeshiftstart: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.

I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 categoryshapeshiftend: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 uirevision: {
 valType: 'any',
 editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

 Closed

my-tien
wants to merge
3
commits into

from

 Closed


categoryshapeshiftstart and categoryshapeshiftend properties for category axes
#7010
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
508f725

categoryshapeshiftstart and categoryshapeshiftend properties for cate…


my-tien Jun 3, 2024
241f31c

Fix shapeBounds calculation


my-tien Jun 3, 2024
b087493

Baseline images for shape_shift_horizontal and shape_shift_vertical


my-tien Jun 3, 2024

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


42 changes: 31 additions & 11 deletions
src/components/shapes/calc_autorange.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

 // paper and axis domain referenced shapes don't affect autorange
 if(shape.xref !== 'paper' && xRefType !== 'domain') {
 var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
 var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
 ax = Axes.getFromId(gd, shape.xref);

 bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
 bounds = shapeBounds(ax, shape, constants.paramIsX, false);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
 }
 }

 if(shape.yref !== 'paper' && yRefType !== 'domain') {
 var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
 var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
 ax = Axes.getFromId(gd, shape.yref);

 bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
 bounds = shapeBounds(ax, shape, constants.paramIsY, true);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
 }
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
 }
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
 var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.
 var isY = axi._id.charAt(0) === 'y';

 var v0;
 var v1;
 var shiftStart = 0;
 var shiftEnd = 0;
 if(isVerticalAxis) {
 var isYSizeModePixel = shape.ysizemode === 'pixel';
 v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
 v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
 } else {
 var isXSizeModePixel = shape.xsizemode === 'pixel';
 v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
 v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
 }

 var convertVal;

 if(ax.type === 'category' || ax.type === 'multicategory') {
 convertVal = ax.r2c;
 if(shape.xsizemode === 'scale') {
 shiftStart = ax.categoryshapeshiftstart;
 shiftEnd = ax.categoryshapeshiftend;
 }
 } else {
 convertVal = ax.d2c;
 }

 if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
 if(!path) return;
 if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
 if(!shape.path) return;

 var min = Infinity;
 var max = -Infinity;
 var segments = path.match(constants.segmentRE);
 var segments = shape.path.match(constants.segmentRE);
 var i;
 var segment;
 var drawnParam;
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/display_labels.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
 // and convert them to pixel coordinates
 // Setup conversion functions
 var xa = Axes.getFromId(gd, options.xref);
 var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
 var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
 var xRefType = Axes.getRefType(options.xref);
 var ya = Axes.getFromId(gd, options.yref);
 var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
 var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
 var yRefType = Axes.getRefType(options.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 shapex0 = x2p(options.x0);
 shapex1 = x2p(options.x1);
 shapey0 = y2p(options.y0);
 shapey1 = y2p(options.y1);
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 shapex0 = x2p(options.x0, xShiftStart);
 shapex1 = x2p(options.x1, xShiftEnd);
 shapey0 = y2p(options.y0, yShiftStart);
 shapey1 = y2p(options.y1, yShiftEnd);
 }

 // Handle `auto` angle
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 var xRefType = Axes.getRefType(shapeOptions.xref);
 var ya = Axes.getFromId(gd, shapeOptions.yref);
 var yRefType = Axes.getRefType(shapeOptions.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
 var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
 var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
 var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
 var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'start-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
 r: circleRadius
 })
 .style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'end-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
 r: circleRadius
 })
 .style(circleStyle)
Expand Down

42 changes: 32 additions & 10 deletions
src/components/shapes/helpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
 return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
 var gs = gd._fullLayout._size;
 var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
 var d2r = exports.shapePositionToRange(axis);

 dataToPixel = function(v) {
 return axis._offset + axis.r2p(d2r(v, true));
 var shiftPixels = 0;
 if(axis.type === 'category' || axis.type === 'multicategory') {
 if(isVertical) {
 shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
 } else {
 shiftPixels = axis.r2p(0.5) * shift;
 }
 }
 return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
 };

 if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
 var ya = Axes.getFromId(gd, options.yref);
 var gs = gd._fullLayout._size;
 var x2r, x2p, y2r, y2p;
 var xShiftStart = 0;
 var xShiftEnd = 0;
 var yShiftStart = 0;
 var yShiftEnd = 0;
 var x0, x1, y0, y1;

 if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
 } else {
 x2r = exports.shapePositionToRange(xa);
 x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
 if(xa.type === 'category' || xa.type === 'multicategory') {
 var shiftUnitX = xa.r2p(0.5);
 xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
 xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
 }
 }
 } else {
 x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
 } else {
 y2r = exports.shapePositionToRange(ya);
 y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
 if(ya.type === 'category' || ya.type === 'multicategory') {
 var shiftUnitY = ya.r2p(0) - ya.r2p(1);
 yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
 yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
 }
 }
 } else {
 y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

 if(options.xsizemode === 'pixel') {
 var xAnchorPos = x2p(options.xanchor);
 x0 = xAnchorPos + options.x0;
 x1 = xAnchorPos + options.x1;
 x0 = xAnchorPos + options.x0 + xShiftStart;
 x1 = xAnchorPos + options.x1 + xShiftEnd;
 } else {
 x0 = x2p(options.x0);
 x1 = x2p(options.x1);
 x0 = x2p(options.x0) + xShiftStart;
 x1 = x2p(options.x1) + xShiftEnd;
 }

 if(options.ysizemode === 'pixel') {
 var yAnchorPos = y2p(options.yanchor);
 y0 = yAnchorPos - options.y0;
 y1 = yAnchorPos - options.y1;
 y0 = yAnchorPos - options.y0 - yShiftStart;
 y1 = yAnchorPos - options.y1 - yShiftEnd;
 } else {
 y0 = y2p(options.y0);
 y1 = y2p(options.y1);
 y0 = y2p(options.y0) - yShiftStart;
 y1 = y2p(options.y1) - yShiftEnd;
 }

 if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down

5 changes: 5 additions & 0 deletions
src/plots/cartesian/axis_defaults.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

 handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

 if(axType === 'category' || axType === 'multicategory') {
 containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
 containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
 }

 if(axType !== 'category' && !options.noHover) coerce('hoverformat');

 var dfltColor = coerce('color');
Expand Down

22 changes: 22 additions & 0 deletions
src/plots/cartesian/layout_attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
 'Used with `categoryorder`.'
 ].join(' ')
 },
 categoryshapeshiftstart: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.

I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 categoryshapeshiftend: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 uirevision: {
 valType: 'any',
 editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

 Closed

my-tien
wants to merge
3
commits into

from

 Closed


categoryshapeshiftstart and categoryshapeshiftend properties for category axes
#7010
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
508f725

categoryshapeshiftstart and categoryshapeshiftend properties for cate…


my-tien Jun 3, 2024
241f31c

Fix shapeBounds calculation


my-tien Jun 3, 2024
b087493

Baseline images for shape_shift_horizontal and shape_shift_vertical


my-tien Jun 3, 2024

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


42 changes: 31 additions & 11 deletions
src/components/shapes/calc_autorange.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

 // paper and axis domain referenced shapes don't affect autorange
 if(shape.xref !== 'paper' && xRefType !== 'domain') {
 var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
 var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
 ax = Axes.getFromId(gd, shape.xref);

 bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
 bounds = shapeBounds(ax, shape, constants.paramIsX, false);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
 }
 }

 if(shape.yref !== 'paper' && yRefType !== 'domain') {
 var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
 var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
 ax = Axes.getFromId(gd, shape.yref);

 bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
 bounds = shapeBounds(ax, shape, constants.paramIsY, true);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
 }
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
 }
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
 var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.
 var isY = axi._id.charAt(0) === 'y';

 var v0;
 var v1;
 var shiftStart = 0;
 var shiftEnd = 0;
 if(isVerticalAxis) {
 var isYSizeModePixel = shape.ysizemode === 'pixel';
 v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
 v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
 } else {
 var isXSizeModePixel = shape.xsizemode === 'pixel';
 v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
 v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
 }

 var convertVal;

 if(ax.type === 'category' || ax.type === 'multicategory') {
 convertVal = ax.r2c;
 if(shape.xsizemode === 'scale') {
 shiftStart = ax.categoryshapeshiftstart;
 shiftEnd = ax.categoryshapeshiftend;
 }
 } else {
 convertVal = ax.d2c;
 }

 if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
 if(!path) return;
 if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
 if(!shape.path) return;

 var min = Infinity;
 var max = -Infinity;
 var segments = path.match(constants.segmentRE);
 var segments = shape.path.match(constants.segmentRE);
 var i;
 var segment;
 var drawnParam;
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/display_labels.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
 // and convert them to pixel coordinates
 // Setup conversion functions
 var xa = Axes.getFromId(gd, options.xref);
 var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
 var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
 var xRefType = Axes.getRefType(options.xref);
 var ya = Axes.getFromId(gd, options.yref);
 var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
 var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
 var yRefType = Axes.getRefType(options.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 shapex0 = x2p(options.x0);
 shapex1 = x2p(options.x1);
 shapey0 = y2p(options.y0);
 shapey1 = y2p(options.y1);
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 shapex0 = x2p(options.x0, xShiftStart);
 shapex1 = x2p(options.x1, xShiftEnd);
 shapey0 = y2p(options.y0, yShiftStart);
 shapey1 = y2p(options.y1, yShiftEnd);
 }

 // Handle `auto` angle
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 var xRefType = Axes.getRefType(shapeOptions.xref);
 var ya = Axes.getFromId(gd, shapeOptions.yref);
 var yRefType = Axes.getRefType(shapeOptions.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
 var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
 var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
 var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
 var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'start-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
 r: circleRadius
 })
 .style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'end-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
 r: circleRadius
 })
 .style(circleStyle)
Expand Down

42 changes: 32 additions & 10 deletions
src/components/shapes/helpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
 return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
 var gs = gd._fullLayout._size;
 var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
 var d2r = exports.shapePositionToRange(axis);

 dataToPixel = function(v) {
 return axis._offset + axis.r2p(d2r(v, true));
 var shiftPixels = 0;
 if(axis.type === 'category' || axis.type === 'multicategory') {
 if(isVertical) {
 shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
 } else {
 shiftPixels = axis.r2p(0.5) * shift;
 }
 }
 return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
 };

 if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
 var ya = Axes.getFromId(gd, options.yref);
 var gs = gd._fullLayout._size;
 var x2r, x2p, y2r, y2p;
 var xShiftStart = 0;
 var xShiftEnd = 0;
 var yShiftStart = 0;
 var yShiftEnd = 0;
 var x0, x1, y0, y1;

 if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
 } else {
 x2r = exports.shapePositionToRange(xa);
 x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
 if(xa.type === 'category' || xa.type === 'multicategory') {
 var shiftUnitX = xa.r2p(0.5);
 xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
 xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
 }
 }
 } else {
 x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
 } else {
 y2r = exports.shapePositionToRange(ya);
 y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
 if(ya.type === 'category' || ya.type === 'multicategory') {
 var shiftUnitY = ya.r2p(0) - ya.r2p(1);
 yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
 yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
 }
 }
 } else {
 y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

 if(options.xsizemode === 'pixel') {
 var xAnchorPos = x2p(options.xanchor);
 x0 = xAnchorPos + options.x0;
 x1 = xAnchorPos + options.x1;
 x0 = xAnchorPos + options.x0 + xShiftStart;
 x1 = xAnchorPos + options.x1 + xShiftEnd;
 } else {
 x0 = x2p(options.x0);
 x1 = x2p(options.x1);
 x0 = x2p(options.x0) + xShiftStart;
 x1 = x2p(options.x1) + xShiftEnd;
 }

 if(options.ysizemode === 'pixel') {
 var yAnchorPos = y2p(options.yanchor);
 y0 = yAnchorPos - options.y0;
 y1 = yAnchorPos - options.y1;
 y0 = yAnchorPos - options.y0 - yShiftStart;
 y1 = yAnchorPos - options.y1 - yShiftEnd;
 } else {
 y0 = y2p(options.y0);
 y1 = y2p(options.y1);
 y0 = y2p(options.y0) - yShiftStart;
 y1 = y2p(options.y1) - yShiftEnd;
 }

 if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down

5 changes: 5 additions & 0 deletions
src/plots/cartesian/axis_defaults.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

 handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

 if(axType === 'category' || axType === 'multicategory') {
 containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
 containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
 }

 if(axType !== 'category' && !options.noHover) coerce('hoverformat');

 var dfltColor = coerce('color');
Expand Down

22 changes: 22 additions & 0 deletions
src/plots/cartesian/layout_attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
 'Used with `categoryorder`.'
 ].join(' ')
 },
 categoryshapeshiftstart: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.

I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 categoryshapeshiftend: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 uirevision: {
 valType: 'any',
 editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

 Closed

my-tien
wants to merge
3
commits into

from

 Closed


categoryshapeshiftstart and categoryshapeshiftend properties for category axes
#7010
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
508f725

categoryshapeshiftstart and categoryshapeshiftend properties for cate…


my-tien Jun 3, 2024
241f31c

Fix shapeBounds calculation


my-tien Jun 3, 2024
b087493

Baseline images for shape_shift_horizontal and shape_shift_vertical


my-tien Jun 3, 2024

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


42 changes: 31 additions & 11 deletions
src/components/shapes/calc_autorange.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

 // paper and axis domain referenced shapes don't affect autorange
 if(shape.xref !== 'paper' && xRefType !== 'domain') {
 var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
 var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
 ax = Axes.getFromId(gd, shape.xref);

 bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
 bounds = shapeBounds(ax, shape, constants.paramIsX, false);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
 }
 }

 if(shape.yref !== 'paper' && yRefType !== 'domain') {
 var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
 var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
 ax = Axes.getFromId(gd, shape.yref);

 bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
 bounds = shapeBounds(ax, shape, constants.paramIsY, true);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
 }
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
 }
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
 var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.
 var isY = axi._id.charAt(0) === 'y';

 var v0;
 var v1;
 var shiftStart = 0;
 var shiftEnd = 0;
 if(isVerticalAxis) {
 var isYSizeModePixel = shape.ysizemode === 'pixel';
 v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
 v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
 } else {
 var isXSizeModePixel = shape.xsizemode === 'pixel';
 v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
 v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
 }

 var convertVal;

 if(ax.type === 'category' || ax.type === 'multicategory') {
 convertVal = ax.r2c;
 if(shape.xsizemode === 'scale') {
 shiftStart = ax.categoryshapeshiftstart;
 shiftEnd = ax.categoryshapeshiftend;
 }
 } else {
 convertVal = ax.d2c;
 }

 if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
 if(!path) return;
 if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
 if(!shape.path) return;

 var min = Infinity;
 var max = -Infinity;
 var segments = path.match(constants.segmentRE);
 var segments = shape.path.match(constants.segmentRE);
 var i;
 var segment;
 var drawnParam;
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/display_labels.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
 // and convert them to pixel coordinates
 // Setup conversion functions
 var xa = Axes.getFromId(gd, options.xref);
 var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
 var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
 var xRefType = Axes.getRefType(options.xref);
 var ya = Axes.getFromId(gd, options.yref);
 var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
 var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
 var yRefType = Axes.getRefType(options.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 shapex0 = x2p(options.x0);
 shapex1 = x2p(options.x1);
 shapey0 = y2p(options.y0);
 shapey1 = y2p(options.y1);
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 shapex0 = x2p(options.x0, xShiftStart);
 shapex1 = x2p(options.x1, xShiftEnd);
 shapey0 = y2p(options.y0, yShiftStart);
 shapey1 = y2p(options.y1, yShiftEnd);
 }

 // Handle `auto` angle
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 var xRefType = Axes.getRefType(shapeOptions.xref);
 var ya = Axes.getFromId(gd, shapeOptions.yref);
 var yRefType = Axes.getRefType(shapeOptions.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
 var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
 var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
 var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
 var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'start-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
 r: circleRadius
 })
 .style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'end-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
 r: circleRadius
 })
 .style(circleStyle)
Expand Down

42 changes: 32 additions & 10 deletions
src/components/shapes/helpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
 return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
 var gs = gd._fullLayout._size;
 var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
 var d2r = exports.shapePositionToRange(axis);

 dataToPixel = function(v) {
 return axis._offset + axis.r2p(d2r(v, true));
 var shiftPixels = 0;
 if(axis.type === 'category' || axis.type === 'multicategory') {
 if(isVertical) {
 shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
 } else {
 shiftPixels = axis.r2p(0.5) * shift;
 }
 }
 return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
 };

 if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
 var ya = Axes.getFromId(gd, options.yref);
 var gs = gd._fullLayout._size;
 var x2r, x2p, y2r, y2p;
 var xShiftStart = 0;
 var xShiftEnd = 0;
 var yShiftStart = 0;
 var yShiftEnd = 0;
 var x0, x1, y0, y1;

 if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
 } else {
 x2r = exports.shapePositionToRange(xa);
 x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
 if(xa.type === 'category' || xa.type === 'multicategory') {
 var shiftUnitX = xa.r2p(0.5);
 xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
 xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
 }
 }
 } else {
 x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
 } else {
 y2r = exports.shapePositionToRange(ya);
 y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
 if(ya.type === 'category' || ya.type === 'multicategory') {
 var shiftUnitY = ya.r2p(0) - ya.r2p(1);
 yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
 yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
 }
 }
 } else {
 y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

 if(options.xsizemode === 'pixel') {
 var xAnchorPos = x2p(options.xanchor);
 x0 = xAnchorPos + options.x0;
 x1 = xAnchorPos + options.x1;
 x0 = xAnchorPos + options.x0 + xShiftStart;
 x1 = xAnchorPos + options.x1 + xShiftEnd;
 } else {
 x0 = x2p(options.x0);
 x1 = x2p(options.x1);
 x0 = x2p(options.x0) + xShiftStart;
 x1 = x2p(options.x1) + xShiftEnd;
 }

 if(options.ysizemode === 'pixel') {
 var yAnchorPos = y2p(options.yanchor);
 y0 = yAnchorPos - options.y0;
 y1 = yAnchorPos - options.y1;
 y0 = yAnchorPos - options.y0 - yShiftStart;
 y1 = yAnchorPos - options.y1 - yShiftEnd;
 } else {
 y0 = y2p(options.y0);
 y1 = y2p(options.y1);
 y0 = y2p(options.y0) - yShiftStart;
 y1 = y2p(options.y1) - yShiftEnd;
 }

 if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down

5 changes: 5 additions & 0 deletions
src/plots/cartesian/axis_defaults.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

 handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

 if(axType === 'category' || axType === 'multicategory') {
 containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
 containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
 }

 if(axType !== 'category' && !options.noHover) coerce('hoverformat');

 var dfltColor = coerce('color');
Expand Down

22 changes: 22 additions & 0 deletions
src/plots/cartesian/layout_attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
 'Used with `categoryorder`.'
 ].join(' ')
 },
 categoryshapeshiftstart: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.

I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 categoryshapeshiftend: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 uirevision: {
 valType: 'any',
 editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
categoryshapeshiftstart and categoryshapeshiftend properties for category axes#7010

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

 Closed

my-tien
wants to merge
3
commits into

from

 Closed


categoryshapeshiftstart and categoryshapeshiftend properties for category axes
#7010
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
508f725

categoryshapeshiftstart and categoryshapeshiftend properties for cate…


my-tien Jun 3, 2024
241f31c

Fix shapeBounds calculation


my-tien Jun 3, 2024
b087493

Baseline images for shape_shift_horizontal and shape_shift_vertical


my-tien Jun 3, 2024

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


42 changes: 31 additions & 11 deletions
src/components/shapes/calc_autorange.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,22 +23,18 @@ module.exports = function calcAutorange(gd) {

 // paper and axis domain referenced shapes don't affect autorange
 if(shape.xref !== 'paper' && xRefType !== 'domain') {
 var vx0 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x0;
 var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
 ax = Axes.getFromId(gd, shape.xref);

 bounds = shapeBounds(ax, vx0, vx1, shape.path, constants.paramIsX);
 bounds = shapeBounds(ax, shape, constants.paramIsX, false);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsX,false);
bounds=shapeBounds(ax,shape,constants.paramIsX);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
 }
 }

 if(shape.yref !== 'paper' && yRefType !== 'domain') {
 var vy0 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y0;
 var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
 ax = Axes.getFromId(gd, shape.yref);

 bounds = shapeBounds(ax, vy0, vy1, shape.path, constants.paramIsY);
 bounds = shapeBounds(ax, shape, constants.paramIsY, true);
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

After considering https://github.com/plotly/plotly.js/pull/7010/files#r1626065612

Suggested change

bounds=shapeBounds(ax,shape,constants.paramIsY,true);
bounds=shapeBounds(ax,shape,constants.paramIsY);
 if(bounds) {
 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
 }
Expand DownExpand Up@@ -77,15 +73,39 @@ function calcPaddingOptions(lineWidth, sizeMode, v0, v1, path, isYAxis) {
 }
}

function shapeBounds(ax, v0, v1, path, paramsToUse) {
 var convertVal = (ax.type === 'category' || ax.type === 'multicategory') ? ax.r2c : ax.d2c;
function shapeBounds(ax, shape, paramsToUse, isVerticalAxis) {
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Let's drop the isVerticalAxis argument and instead use the ax._id.
 var isY = axi._id.charAt(0) === 'y';

 var v0;
 var v1;
 var shiftStart = 0;
 var shiftEnd = 0;
 if(isVerticalAxis) {
 var isYSizeModePixel = shape.ysizemode === 'pixel';
 v0 = isYSizeModePixel ? shape.yanchor : shape.y0;
 v1 = isYSizeModePixel ? shape.yanchor : shape.y1;
 } else {
 var isXSizeModePixel = shape.xsizemode === 'pixel';
 v0 = isXSizeModePixel ? shape.xanchor : shape.x0;
 v1 = isXSizeModePixel ? shape.xanchor : shape.x1;
 }

 var convertVal;

 if(ax.type === 'category' || ax.type === 'multicategory') {
 convertVal = ax.r2c;
 if(shape.xsizemode === 'scale') {
 shiftStart = ax.categoryshapeshiftstart;
 shiftEnd = ax.categoryshapeshiftend;
 }
 } else {
 convertVal = ax.d2c;
 }

 if(v0 !== undefined) return [convertVal(v0), convertVal(v1)];
 if(!path) return;
 if(v0 !== undefined) return [convertVal(v0) + shiftStart, convertVal(v1) + shiftEnd];
 if(!shape.path) return;

 var min = Infinity;
 var max = -Infinity;
 var segments = path.match(constants.segmentRE);
 var segments = shape.path.match(constants.segmentRE);
 var i;
 var segment;
 var drawnParam;
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/display_labels.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,15 +88,25 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
 // and convert them to pixel coordinates
 // Setup conversion functions
 var xa = Axes.getFromId(gd, options.xref);
 var xShiftStart = xa ? xa.categoryshapeshiftstart : 0;
 var xShiftEnd = xa ? xa.categoryshapeshiftend : 0;
 var xRefType = Axes.getRefType(options.xref);
 var ya = Axes.getFromId(gd, options.yref);
 var yShiftStart = ya ? ya.categoryshapeshiftstart : 0;
 var yShiftEnd = ya ? ya.categoryshapeshiftend : 0;
 var yRefType = Axes.getRefType(options.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 shapex0 = x2p(options.x0);
 shapex1 = x2p(options.x1);
 shapey0 = y2p(options.y0);
 shapey1 = y2p(options.y1);
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 shapex0 = x2p(options.x0, xShiftStart);
 shapex1 = x2p(options.x1, xShiftEnd);
 shapey0 = y2p(options.y0, yShiftStart);
 shapey1 = y2p(options.y1, yShiftEnd);
 }

 // Handle `auto` angle
Expand Down

22 changes: 16 additions & 6 deletions
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,8 +227,18 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 var xRefType = Axes.getRefType(shapeOptions.xref);
 var ya = Axes.getFromId(gd, shapeOptions.yref);
 var yRefType = Axes.getRefType(shapeOptions.yref);
 var x2p = helpers.getDataToPixel(gd, xa, false, xRefType);
 var y2p = helpers.getDataToPixel(gd, ya, true, yRefType);
 var shiftXStart = xa ? xa.categoryshapeshiftstart : 0;
 var shiftXEnd = xa ? xa.categoryshapeshiftend : 0;
 var shiftYStart = ya ? ya.categoryshapeshiftstart : 0;
 var shiftYEnd = ya ? ya.categoryshapeshiftend : 0;
 var x2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, xa, shift, false, xRefType);
 return dataToPixel(v);
 };
 var y2p = function(v, shift) {
 var dataToPixel = helpers.getDataToPixel(gd, ya, shift, true, yRefType);
 return dataToPixel(v);
 };
 var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
 var p2y = helpers.getPixelToData(gd, ya, true, yRefType);

Expand DownExpand Up@@ -279,8 +289,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'start-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0, shiftXStart),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0, shiftYStart),
 r: circleRadius
 })
 .style(circleStyle)
Expand All@@ -289,8 +299,8 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
 g.append('circle')
 .attr({
 'data-line-point': 'end-point',
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1),
 cx: xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1, shiftXEnd),
 cy: yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1, shiftYEnd),
 r: circleRadius
 })
 .style(circleStyle)
Expand Down

42 changes: 32 additions & 10 deletions
src/components/shapes/helpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ exports.extractPathCoords = function(path, paramsToUse, isRaw) {
 return extractedCoordinates;
};

exports.getDataToPixel = function(gd, axis, isVertical, refType) {
exports.getDataToPixel = function(gd, axis, shift, isVertical, refType) {
 var gs = gd._fullLayout._size;
 var dataToPixel;

Expand All@@ -66,7 +66,15 @@ exports.getDataToPixel = function(gd, axis, isVertical, refType) {
 var d2r = exports.shapePositionToRange(axis);

 dataToPixel = function(v) {
 return axis._offset + axis.r2p(d2r(v, true));
 var shiftPixels = 0;
 if(axis.type === 'category' || axis.type === 'multicategory') {
 if(isVertical) {
 shiftPixels = ((axis.r2p(1) - axis.r2p(0)) * shift);
 } else {
 shiftPixels = axis.r2p(0.5) * shift;
 }
 }
 return axis._offset + axis.r2p(d2r(v, true)) + shiftPixels;
 };

 if(axis.type === 'date') dataToPixel = exports.decodeDate(dataToPixel);
Expand DownExpand Up@@ -179,6 +187,10 @@ exports.getPathString = function(gd, options) {
 var ya = Axes.getFromId(gd, options.yref);
 var gs = gd._fullLayout._size;
 var x2r, x2p, y2r, y2p;
 var xShiftStart = 0;
 var xShiftEnd = 0;
 var yShiftStart = 0;
 var yShiftEnd = 0;
 var x0, x1, y0, y1;

 if(xa) {
Expand All@@ -187,6 +199,11 @@ exports.getPathString = function(gd, options) {
 } else {
 x2r = exports.shapePositionToRange(xa);
 x2p = function(v) { return xa._offset + xa.r2p(x2r(v, true)); };
 if(xa.type === 'category' || xa.type === 'multicategory') {
 var shiftUnitX = xa.r2p(0.5);
 xShiftStart = shiftUnitX * xa.categoryshapeshiftstart;
 xShiftEnd = shiftUnitX * xa.categoryshapeshiftend;
 }
 }
 } else {
 x2p = function(v) { return gs.l + gs.w * v; };
Expand All@@ -198,6 +215,11 @@ exports.getPathString = function(gd, options) {
 } else {
 y2r = exports.shapePositionToRange(ya);
 y2p = function(v) { return ya._offset + ya.r2p(y2r(v, true)); };
 if(ya.type === 'category' || ya.type === 'multicategory') {
 var shiftUnitY = ya.r2p(0) - ya.r2p(1);
 yShiftStart = shiftUnitY * ya.categoryshapeshiftstart;
 yShiftEnd = shiftUnitY * ya.categoryshapeshiftend;
 }
 }
 } else {
 y2p = function(v) { return gs.t + gs.h * (1 - v); };
Expand All@@ -211,20 +233,20 @@ exports.getPathString = function(gd, options) {

 if(options.xsizemode === 'pixel') {
 var xAnchorPos = x2p(options.xanchor);
 x0 = xAnchorPos + options.x0;
 x1 = xAnchorPos + options.x1;
 x0 = xAnchorPos + options.x0 + xShiftStart;
 x1 = xAnchorPos + options.x1 + xShiftEnd;
 } else {
 x0 = x2p(options.x0);
 x1 = x2p(options.x1);
 x0 = x2p(options.x0) + xShiftStart;
 x1 = x2p(options.x1) + xShiftEnd;
 }

 if(options.ysizemode === 'pixel') {
 var yAnchorPos = y2p(options.yanchor);
 y0 = yAnchorPos - options.y0;
 y1 = yAnchorPos - options.y1;
 y0 = yAnchorPos - options.y0 - yShiftStart;
 y1 = yAnchorPos - options.y1 - yShiftEnd;
 } else {
 y0 = y2p(options.y0);
 y1 = y2p(options.y1);
 y0 = y2p(options.y0) - yShiftStart;
 y1 = y2p(options.y1) - yShiftEnd;
 }

 if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
Expand Down

5 changes: 5 additions & 0 deletions
src/plots/cartesian/axis_defaults.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

 handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

 if(axType === 'category' || axType === 'multicategory') {
 containerOut.categoryshapeshiftstart = containerIn.categoryshapeshiftstart || 0;
 containerOut.categoryshapeshiftend = containerIn.categoryshapeshiftend || 0;
 }

 if(axType !== 'category' && !options.noHover) coerce('hoverformat');

 var dfltColor = coerce('color');
Expand Down

22 changes: 22 additions & 0 deletions
src/plots/cartesian/layout_attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1190,6 +1190,28 @@ module.exports = {
 'Used with `categoryorder`.'
 ].join(' ')
 },
 categoryshapeshiftstart: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Perhaps increasing the range of min and max a bit could be useful to highlight points for cases e.g. histogram and bars with tiny gaps.

I suggest we allow values between -0.7 and 0.7 or maybe even -1 and 1?
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x0/y0 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 categoryshapeshiftend: {
 valType: 'number',
 dflt: 0,
 min: -0.5,
 max: 0.5,
 editType: 'calc',
 description: [
 'Only relevant if axis is a (multi-)category axes. Shifts x1/y1 by a fraction of the',
 'reference unit.'
 ]
@archmojarchmojJun 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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


Suggested change

]
].join(' ')
 },
 uirevision: {
 valType: 'any',
 editType: 'none',
Expand Down
Binary file addedtest/image/baselines/zzz_shape_shift_horizontal.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addedtest/image/baselines/zzz_shape_shift_vertical.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading