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

fix: added missing export of CanvasSourceSpecification #13369

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

Conversation

fxnm
Copy link
Contributor

@fxnm fxnm commented Dec 22, 2024

Moved CanvasSourceSpecification so that the type will be exported, similar to GeoJSONSourceSpecification, VideoSourceSpecification and all other Source Specifications.

https://docs.mapbox.com/mapbox-gl-js/api/sources/#canvassourceoptions

Launch Checklist

  • Make sure the PR title is descriptive and preferably reflects the change from the user's perspective.
  • Add additional detail and context in the PR description (with screenshots/videos if there are visual changes).
  • Manually test the debug page.
  • Write tests for all new functionality and make sure the CI checks pass.
  • Document any changes to public APIs.
  • Post benchmark scores if the change could affect performance.
  • Tag @mapbox/map-design-team @mapbox/static-apis if this PR includes style spec API or visual changes.
  • Tag @mapbox/gl-native if this PR includes shader changes or needs a native port.

@@ -392,6 +392,13 @@ export type ModelSourceSpecification = {
"tiles"?: Array<string>
}

export type CanvasSourceSpecification = {
Copy link
Member

Choose a reason for hiding this comment

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

CanvasSource is purely a GL JS runtime entity. Thus, it doesn't belong to the Style Specification. You can alternatively import the type from canvas_source.ts in src/source/source_types.ts it is a bit will change convention, but it reflects actual state anyway

Copy link
Member

@underoot underoot Jan 17, 2025

Choose a reason for hiding this comment

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

It's automatically generated file from style-spec. See the header of file for the details

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