diff --git a/draftlogs/7981_fix.md b/draftlogs/7981_fix.md new file mode 100644 index 00000000000..9a8d516209a --- /dev/null +++ b/draftlogs/7981_fix.md @@ -0,0 +1 @@ +- Correct the `showspikes` axis attribute description to clarify that it applies for all `hovermode` values except when `hovermode` is *false* [[#7981](https://github.com/plotly/plotly.js/pull/7981)], with thanks for @CAOShurong for the contribution! diff --git a/src/plots/cartesian/layout_attributes.js b/src/plots/cartesian/layout_attributes.js index d7c207fd21f..8d534a846a1 100644 --- a/src/plots/cartesian/layout_attributes.js +++ b/src/plots/cartesian/layout_attributes.js @@ -780,7 +780,7 @@ module.exports = { editType: 'modebar', description: [ 'Determines whether or not spikes (aka droplines) are drawn for this axis.', - 'Note: This only takes affect when hovermode = closest' + 'Note that spikes will never be drawn when `hovermode` is *false*.' ].join(' ') }, spikecolor: { diff --git a/src/types/generated/schema.d.ts b/src/types/generated/schema.d.ts index b01d6d9185c..2c08fa0db33 100644 --- a/src/types/generated/schema.d.ts +++ b/src/types/generated/schema.d.ts @@ -12534,7 +12534,7 @@ export interface LayoutAxis { */ showline?: boolean; /** - * Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest + * Determines whether or not spikes (aka droplines) are drawn for this axis. Note that spikes will never be drawn when `hovermode` is *false*. * @default false */ showspikes?: boolean; diff --git a/test/plot-schema.json b/test/plot-schema.json index 0412ea47de0..4598de7f54c 100644 --- a/test/plot-schema.json +++ b/test/plot-schema.json @@ -13953,7 +13953,7 @@ "valType": "boolean" }, "showspikes": { - "description": "Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest", + "description": "Determines whether or not spikes (aka droplines) are drawn for this axis. Note that spikes will never be drawn when `hovermode` is *false*.", "dflt": false, "editType": "modebar", "valType": "boolean" @@ -15202,7 +15202,7 @@ "valType": "boolean" }, "showspikes": { - "description": "Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest", + "description": "Determines whether or not spikes (aka droplines) are drawn for this axis. Note that spikes will never be drawn when `hovermode` is *false*.", "dflt": false, "editType": "modebar", "valType": "boolean"