Skip to content

[GH-2678] Add SVG visuals for overlay functions (Phase 2)#2682

Merged
jiayuasu merged 1 commit intomasterfrom
fix/issue-2678-overlay-visuals
Mar 4, 2026
Merged

[GH-2678] Add SVG visuals for overlay functions (Phase 2)#2682
jiayuasu merged 1 commit intomasterfrom
fix/issue-2678-overlay-visuals

Conversation

@jiayuasu
Copy link
Member

@jiayuasu jiayuasu commented Mar 4, 2026

Did you read the Contributor Guide?

Is this PR related to a ticket?

What changes were proposed in this PR?

Added SVG visual illustrations for 7 overlay functions (Phase 2 of #2678):

  • ST_Intersection, ST_Union, ST_Difference, ST_SymDifference
  • ST_Split, ST_SubDivide (also used by ST_SubDivideExplode), ST_UnaryUnion

Each overlay function gets one SVG showing input geometries (A and B in dashed outline) with the result region highlighted in green. For single-geometry functions (ST_SubDivide, ST_UnaryUnion), only geometry A is shown.

SVG files stored in docs/image/ST_Name/. Images embedded in 22 markdown files across:

  • docs/api/sql/Overlay-Functions/
  • docs/api/flink/Overlay-Functions/
  • docs/api/snowflake/vector-data/Overlay-Functions/

How was this patch tested?

  • Verified all 7 SVG files exist and render correctly
  • Verified all image references in 22 markdown files resolve to existing files (no broken links)
  • Visual inspection of SVG output

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation.

Added SVG illustrations for 7 overlay functions showing input geometries
and highlighted results:
- ST_Intersection, ST_Union, ST_Difference, ST_SymDifference
- ST_Split, ST_SubDivide, ST_UnaryUnion

ST_SubDivideExplode reuses the ST_SubDivide diagram.

Images embedded in 22 markdown files across SQL, Flink, and Snowflake docs.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds Phase 2 visual documentation for Sedona overlay functions by introducing new SVG illustrations and embedding them into the SQL, Flink, and Snowflake function reference pages (per #2678).

Changes:

  • Added 7 new SVG diagrams illustrating inputs (A/B) and the result region for overlay operations.
  • Embedded these SVGs into 22 overlay-function Markdown docs across SQL, Flink, and Snowflake sections.
  • Reused the ST_SubDivide SVG for the ST_SubDivideExplode docs.

Reviewed changes

Copilot reviewed 22 out of 29 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/image/ST_Union/ST_Union.svg New SVG illustrating ST_Union(A, B) result region
docs/image/ST_UnaryUnion/ST_UnaryUnion.svg New SVG illustrating ST_UnaryUnion(A) result region
docs/image/ST_SymDifference/ST_SymDifference.svg New SVG illustrating ST_SymDifference(A, B) result region
docs/image/ST_SubDivide/ST_SubDivide.svg New SVG illustrating ST_SubDivide(A, maxVertices) result regions
docs/image/ST_Split/ST_Split.svg New SVG illustrating ST_Split(A, blade) result regions
docs/image/ST_Intersection/ST_Intersection.svg New SVG illustrating ST_Intersection(A, B) result region
docs/image/ST_Difference/ST_Difference.svg New SVG illustrating ST_Difference(A, B) result region
docs/api/sql/Overlay-Functions/ST_Union.md Embed ST_Union SVG in SQL docs
docs/api/sql/Overlay-Functions/ST_UnaryUnion.md Embed ST_UnaryUnion SVG in SQL docs
docs/api/sql/Overlay-Functions/ST_SymDifference.md Embed ST_SymDifference SVG in SQL docs
docs/api/sql/Overlay-Functions/ST_SubDivideExplode.md Embed ST_SubDivide SVG (reused) for ST_SubDivideExplode in SQL docs
docs/api/sql/Overlay-Functions/ST_SubDivide.md Embed ST_SubDivide SVG in SQL docs
docs/api/sql/Overlay-Functions/ST_Split.md Embed ST_Split SVG in SQL docs
docs/api/sql/Overlay-Functions/ST_Intersection.md Embed ST_Intersection SVG in SQL docs
docs/api/sql/Overlay-Functions/ST_Difference.md Embed ST_Difference SVG in SQL docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_Union.md Embed ST_Union SVG in Snowflake docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_UnaryUnion.md Embed ST_UnaryUnion SVG in Snowflake docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_SymDifference.md Embed ST_SymDifference SVG in Snowflake docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_SubDivideExplode.md Embed ST_SubDivide SVG (reused) for ST_SubDivideExplode in Snowflake docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_SubDivide.md Embed ST_SubDivide SVG in Snowflake docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_Split.md Embed ST_Split SVG in Snowflake docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_Intersection.md Embed ST_Intersection SVG in Snowflake docs
docs/api/snowflake/vector-data/Overlay-Functions/ST_Difference.md Embed ST_Difference SVG in Snowflake docs
docs/api/flink/Overlay-Functions/ST_Union.md Embed ST_Union SVG in Flink docs
docs/api/flink/Overlay-Functions/ST_UnaryUnion.md Embed ST_UnaryUnion SVG in Flink docs
docs/api/flink/Overlay-Functions/ST_SymDifference.md Embed ST_SymDifference SVG in Flink docs
docs/api/flink/Overlay-Functions/ST_SubDivide.md Embed ST_SubDivide SVG in Flink docs
docs/api/flink/Overlay-Functions/ST_Intersection.md Embed ST_Intersection SVG in Flink docs
docs/api/flink/Overlay-Functions/ST_Difference.md Embed ST_Difference SVG in Flink docs
Comments suppressed due to low confidence (1)

docs/api/snowflake/vector-data/Overlay-Functions/ST_SubDivideExplode.md:32

  • The Markdown around the "Format" / example SQL block has mismatched backticks ("Format: `" on line 28 and a closing backtick at the end of the SELECT on line 32). This renders the section incorrectly and can swallow subsequent content. Please convert this to a proper inline code span (for the format string) and/or a fenced code block for the SQL example, with balanced backticks.
Format: `
Return type: `Geometry`

SELECT SEDONA.ST_AsText(GEOM)
FROM table(SEDONA.ST_SubDivideExplode(geom: geometry, maxVertices: int))`

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jiayuasu jiayuasu merged commit cfe9785 into master Mar 4, 2026
14 checks passed
@jiayuasu jiayuasu deleted the fix/issue-2678-overlay-visuals branch March 4, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sedona doc should have visuals for individual function to illustrate

2 participants