document raster and contour #1386
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 tasks
mbostock
reviewed
Mar 25, 2023
src/marks/contour.d.ts
Outdated
Comment on lines
93
to
106
| * The resolution of the underlying raster grid may be specified with the | ||
| * following options: | ||
| * | ||
| * * **width** - the number of pixels on each horizontal line | ||
| * * **height** - the number of lines; a positive integer | ||
| * | ||
| * The raster dimensions may also be imputed from the extent of *x* and *y* and | ||
| * a pixel size: | ||
| * | ||
| * * **x1** - the starting horizontal position; bound to the *x* scale | ||
| * * **x2** - the ending horizontal position; bound to the *x* scale | ||
| * * **y1** - the starting vertical position; bound to the *y* scale | ||
| * * **y2** - the ending vertical position; bound to the *y* scale | ||
| * * **pixelSize** - the screen size of a raster pixel; defaults to 1 |
There was a problem hiding this comment.
I don’t think we should repeat the options here; that should be covered by the ContourOptions/RasterOptions interface. (This description is quite long and we should look for ways to pare it down.)
mbostock
reviewed
Mar 25, 2023
mbostock
reviewed
Mar 25, 2023
src/marks/raster.d.ts
Outdated
Comment on lines
162
to
173
| * The resolution of the rectangular raster image may be specified with the following options: | ||
| * | ||
| * * **width** - the number of pixels on each horizontal line | ||
| * * **height** - the number of lines; a positive integer | ||
| * | ||
| * The raster dimensions may also be imputed from the extent of *x* and *y* and a pixel size: | ||
| * | ||
| * * **x1** - the starting horizontal position; bound to the *x* scale | ||
| * * **x2** - the ending horizontal position; bound to the *x* scale | ||
| * * **y1** - the starting vertical position; bound to the *y* scale | ||
| * * **y2** - the ending vertical position; bound to the *y* scale | ||
| * * **pixelSize** - the screen size of a raster pixel; defaults to 1 |
There was a problem hiding this comment.
Same comment re. enumeration of options.
mbostock
reviewed
Mar 25, 2023
src/marks/raster.d.ts
Outdated
Comment on lines
218
to
254
| random?: RandomSource; | ||
| minDistance?: number; | ||
| maxSteps?: number; |
mbostock
reviewed
Mar 25, 2023
src/marks/raster.d.ts
Outdated
Comment on lines
126
to
127
| * The [image-rendering | ||
| * attribute](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/image-rendering); |
There was a problem hiding this comment.
I’ve started using footnote-style links in Markdown to reduce the wrapping problems with long URLs.
mbostock
reviewed
Mar 25, 2023
mbostock
reviewed
Mar 25, 2023
src/marks/raster.d.ts
Outdated
| * from the frame’s dimensions and the *x* and *y* extents. | ||
| */ | ||
| interval?: Interval; | ||
| /** |
There was a problem hiding this comment.
Use a blank line between options (unless using the dense form with one-line comments).
mbostock
reviewed
Mar 25, 2023
src/marks/raster.d.ts
Outdated
Comment on lines
67
to
68
| * The lower value of *x*, on the left edge of the raster (right edge if | ||
| * reversed). |
There was a problem hiding this comment.
This and other options need the defaults described (which is a bit tedious to describe because there are a lot of different defaults at play here, but that’s a big part of the value that documentation provides).
There was a problem hiding this comment.
I hope I got those right.
mbostock
reviewed
Mar 31, 2023
src/marks/raster.d.ts
Outdated
Comment on lines
122
to
126
| /** | ||
| * The sampling interval, used to determine the height and width of the raster | ||
| * from the frame’s dimensions and the *x* and *y* extents. | ||
| */ | ||
| interval?: Interval; |
There was a problem hiding this comment.
The raster mark doesn’t support the interval option; that’s only for the contour mark.
mbostock
approved these changes
Mar 31, 2023
chaichontat
pushed a commit
to chaichontat/plot
that referenced
this pull request
Jan 14, 2024
* a weird space * document raster * document contour * cleaner * better contour, raster * defaults for x1, x2, y1, y2 (I think) * edits * edits * edits --------- Co-authored-by: Mike Bostock <[email protected]>
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.
for #1343
Note: added interval in the raster options, and explicitly discarded the raster interval option from the type, to add the contour interval option instead—not sure it's needed, but it felt like the right thing to do.