exclude tip from TipOptions (#2459) - #2462
Open
cpruijsen wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2459.
MarkOptions.tipis typed asTipOptions, andTipOptionsextendedMarkOptions, so nestedtipobjects typechecked:The tip mark cannot have a nested tip. The constructor already forces
tip: falsewhenoptions.tipis truthy. This change makesTipOptionsextendOmit<MarkOptions, "tip">so the types match that.Decision
tipfromTipOptionsitself.TipOptions extends MarkOptionsand omittiponly on the object type ofMarkOptions.tip.Plot.tip()behaves at runtime.RasterOptionsalready usesOmit<MarkOptions, …>for options a mark cannot use.OmitonMarkOptions.tipif you would rather leavePlot.tip(data, { tip: false })typechecking as a no-op.No runtime or docs change; the tip-mark docs never listed a
tipoption onPlot.tip().Test plan
Plot.dot([], { tip: { tip: true } })is a type errorPlot.tip([], { tip: true })is a type errorPlot.dot([], { tip: true })still typechecksPlot.dot([], { tip: { anchor: "top", pointer: "xy" } })still typechecksPlot.tip([], { x: 0, y: 0, anchor: "top" })still typechecks