Skip to content
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.

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

document the custom render option #1811

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

document the custom render option #1811

wants to merge 3 commits into from

Conversation

Fil
Copy link
Contributor

@Fil Fil commented Aug 16, 2023

If we do an “Extending Plot” page, maybe it should cover more than the render function?

For #1711

@Fil Fil requested a review from mbostock August 16, 2023 13:11
docs/features/marks.md Outdated Show resolved Hide resolved
@Fil Fil force-pushed the fil/render-api-docs branch from a03f3ff to e465b79 Compare August 16, 2023 13:13
@Fil Fil changed the title document the custom render option (#1711) document the custom render option Aug 16, 2023
@Fil Fil mentioned this pull request Aug 16, 2023
6 tasks
Copy link
Member

@mbostock mbostock left a comment

Choose a reason for hiding this comment

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

Let’s move this to a “Custom marks” section on the Marks page, like we do for “Custom transforms” on the Transforms page.

Base automatically changed from fil/render-api to main August 16, 2023 18:40
@mbostock
Copy link
Member

mbostock commented Aug 16, 2023

Should we also document the other public Mark methods, and add them to the Mark class TypeScript declaration? Specifically:

  • the Mark constructor
  • mark.initialize
  • mark.filter
  • mark.project
  • mark.scale
  • mark.render

(I also thought about all the public fields on Mark and subclasses, such as mark.data, mark.sort, mark.initializer, etc. But I don’t really want those to be part of the public API. 🤔)

This was referenced Aug 25, 2023
docs/features/marks.md Outdated Show resolved Hide resolved
docs/features/marks.md Outdated Show resolved Hide resolved
docs/features/marks.md Outdated Show resolved Hide resolved
docs/features/marks.md Outdated Show resolved Hide resolved
docs/features/marks.md Outdated Show resolved Hide resolved
docs/features/marks.md Outdated Show resolved Hide resolved
@Fil Fil force-pushed the fil/render-api-docs branch from 33df130 to a74892a Compare September 30, 2024 09:58
@Fil Fil mentioned this pull request Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants