Skip to content

Add SVG Label Rendering Filtering + Rects and fixture #56

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.

Sign up for GitHub

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

Merged
seveibar merged 1 commit into from
May 15, 2025
Merged

Add SVG Label Rendering Filtering + Rects and fixture #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions examples/svg-label-rendering.fixture.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import React from "react"
import { getSvgFromGraphicsObject, GraphicsObject } from "../lib"

const graphicsWithLabels: GraphicsObject = {
title: "SVG Label Rendering Test",
points: [
{ x: 10, y: 10, label: "Point 1", color: "red" },
{ x: 30, y: 10, label: "Point 2", color: "red" },
],
lines: [
{
points: [
{ x: 10, y: 30 },
{ x: 50, y: 30 },
],
strokeColor: "blue",
label: "Line A",
},
],
rects: [
{
center: { x: 30, y: 50 },
width: 30,
height: 10,
fill: "rgba(0, 255, 0, 0.3)",
stroke: "green",
label: "Rect X",
},
],
coordinateSystem: "screen", // Use screen to simplify coordinates for SVG
}

const SvgDisplay: React.FC<{ title: string; svgString: string }> = ({
title,
svgString,
}) => (
<div style={{ marginBottom: "20px", border: "1px solid #eee", padding: "10px" }}>
<h3>{title}</h3>
<div dangerouslySetInnerHTML={{ __html: svgString }} />
</div>
)

export default function SvgLabelRenderingFixture() {
const svgAllLabels = getSvgFromGraphicsObject(graphicsWithLabels, {
includeTextLabels: true,
})
const svgNoLabels = getSvgFromGraphicsObject(graphicsWithLabels, {
includeTextLabels: false,
})
const svgPointLabels = getSvgFromGraphicsObject(graphicsWithLabels, {
includeTextLabels: ["points"],
})
const svgLineLabels = getSvgFromGraphicsObject(graphicsWithLabels, {
includeTextLabels: ["lines"],
})
const svgRectLabels = getSvgFromGraphicsObject(graphicsWithLabels, {
includeTextLabels: ["rects"],
})
const svgPointAndRectLabels = getSvgFromGraphicsObject(graphicsWithLabels, {
includeTextLabels: ["points", "rects"],
})

return (
<div style={{ padding: "20px" }}>
<h2>SVG Label Rendering Test</h2>
<p>
This fixture tests the <code>includeTextLabels</code> option for{" "}
<code>getSvgFromGraphicsObject</code>.
</p>

<SvgDisplay title="Labels: All (true)" svgString={svgAllLabels} />
<SvgDisplay title="Labels: None (false)" svgString={svgNoLabels} />
<SvgDisplay title="Labels: Points Only" svgString={svgPointLabels} />
<SvgDisplay title="Labels: Lines Only" svgString={svgLineLabels} />
<SvgDisplay title="Labels: Rects Only" svgString={svgRectLabels} />
<SvgDisplay
title="Labels: Points and Rects"
svgString={svgPointAndRectLabels}
/>
</div>
)
}
140 changes: 101 additions & 39 deletions lib/getSvgFromGraphicsObject.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,23 @@ export function getSvgFromGraphicsObject(
includeTextLabels = false,
backgroundColor,
}: {
includeTextLabels?: boolean
includeTextLabels?: boolean | Array<"points" | "lines" | "rects">
backgroundColor?: string
} = {},
): string {
const bounds = getBounds(graphics)
const matrix = getProjectionMatrix(bounds, graphics.coordinateSystem)

const shouldRenderLabel = (type: "points" | "lines" | "rects"): boolean => {
if (typeof includeTextLabels === "boolean") {
return includeTextLabels
}
if (Array.isArray(includeTextLabels)) {
return includeTextLabels.includes(type)
}
return false
}

const svgObject = {
name: "svg",
type: "element",
Expand Down Expand Up @@ -143,7 +153,7 @@ export function getSvgFromGraphicsObject(
fill: point.color || "black",
},
},
...(includeTextLabels && point.label
...(shouldRenderLabel("points") && point.label
? [
{
name: "text",
Expand All @@ -162,29 +172,55 @@ export function getSvgFromGraphicsObject(
}
}),
// Lines
...(graphics.lines || []).map((line) => ({
name: "polyline",
type: "element",
attributes: {
"data-points": line.points.map((p) => `${p.x},${p.y}`).join(" "),
"data-type": "line",
points: line.points
.map((p) => projectPoint(p, matrix))
.map((p) => `${p.x},${p.y}`)
.join(" "),
fill: "none",
stroke: line.strokeColor || "black",
"stroke-width": (line.strokeWidth
? line.strokeWidth * matrix.a
: 1
).toString(),
...(line.strokeDash && {
"stroke-dasharray": Array.isArray(line.strokeDash)
? line.strokeDash.join(" ")
: line.strokeDash,
}),
},
})),
...(graphics.lines || []).map((line) => {
const projectedPoints = line.points.map((p) => projectPoint(p, matrix))
return {
name: "g",
type: "element",
attributes: {},
children: [
{
name: "polyline",
type: "element",
attributes: {
"data-points": line.points.map((p) => `${p.x},${p.y}`).join(" "),
"data-type": "line",
"data-label": line.label || "",
points: projectedPoints
.map((p) => `${p.x},${p.y}`)
.join(" "),
fill: "none",
stroke: line.strokeColor || "black",
"stroke-width": (line.strokeWidth
? line.strokeWidth * matrix.a
: 1
).toString(),
...(line.strokeDash && {
"stroke-dasharray": Array.isArray(line.strokeDash)
? line.strokeDash.join(" ")
: line.strokeDash,
}),
},
},
...(shouldRenderLabel("lines") && line.label && projectedPoints.length > 0
? [
{
name: "text",
type: "element",
attributes: {
x: (projectedPoints[0].x + 5).toString(),
y: (projectedPoints[0].y - 5).toString(),
"font-family": "sans-serif",
"font-size": "12",
fill: line.strokeColor || "black",
},
children: [{ type: "text", value: line.label }],
},
]
: []),
],
}
}),
// Rectangles
...(graphics.rects || []).map((rect) => {
const corner1 = {
Expand All @@ -199,22 +235,48 @@ export function getSvgFromGraphicsObject(
const projectedCorner2 = projectPoint(corner2, matrix)
const scaledWidth = Math.abs(projectedCorner2.x - projectedCorner1.x)
const scaledHeight = Math.abs(projectedCorner2.y - projectedCorner1.y)
const rectX = Math.min(projectedCorner1.x, projectedCorner2.x)
const rectY = Math.min(projectedCorner1.y, projectedCorner2.y)

return {
name: "rect",
name: "g",
type: "element",
attributes: {
"data-type": "rect",
"data-label": "",
"data-x": rect.center.x.toString(),
"data-y": rect.center.y.toString(),
x: Math.min(projectedCorner1.x, projectedCorner2.x).toString(),
y: Math.min(projectedCorner1.y, projectedCorner2.y).toString(),
width: scaledWidth.toString(),
height: scaledHeight.toString(),
fill: rect.fill || "none",
stroke: rect.stroke || "black",
"stroke-width": Math.abs(1 / matrix.a).toString(),
},
attributes: {},
children: [
{
name: "rect",
type: "element",
attributes: {
"data-type": "rect",
"data-label": rect.label || "",
"data-x": rect.center.x.toString(),
"data-y": rect.center.y.toString(),
x: rectX.toString(),
y: rectY.toString(),
width: scaledWidth.toString(),
height: scaledHeight.toString(),
fill: rect.fill || "none",
stroke: rect.stroke || "black",
"stroke-width": Math.abs(1 / matrix.a).toString(), // Consider scaling stroke width like lines if needed
},
},
...(shouldRenderLabel("rects") && rect.label
? [
{
name: "text",
type: "element",
attributes: {
x: (rectX + 5).toString(),
y: (rectY - 5).toString(), // Position above the top-left corner
"font-family": "sans-serif",
"font-size": "12",
fill: rect.stroke || "black", // Default to stroke color for label
},
children: [{ type: "text", value: rect.label }],
},
]
: []),
],
}
}),
// Circles
Expand Down