Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
691 changes: 445 additions & 246 deletions docs/ TODO FIXES.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/src/content/components/AnnotationLine.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: AnnotationLine
description: Annotation component drawing a straight marker across the chart to indicate a specific value, trend, or threshold.
section: annotations
layers: ['svg', 'canvas', 'html']
related: ['components/AnnotationPoint', 'components/AnnotationRange']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/AnnotationPoint.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: AnnotationPoint
description: Annotation component marking a specific data value or coordinate on a chart to highlight key events or notable points.
section: annotations
layers: ['svg', 'canvas', 'html']
related: ['components/AnnotationLine', 'components/AnnotationRange']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/AnnotationRange.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: AnnotationRange
description: Annotation component highlighting a continuous span or interval on a chart to emphasize specific data ranges or thresholds.
section: annotations
layers: ['svg', 'canvas', 'html']
related: ['components/AnnotationLine', 'components/AnnotationPoint']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Arc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# description:
description: Primitive component which draws a curved segment on a chart to represent portions of a whole or highlight specific data ranges.
section: primitives
layers: [svg, canvas]
related: [components/Pie, examples/Arc]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/ArcChart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Streamlined Chart configuration for Arc charts
description: Streamlined visualization which draws curved segment of a chart to represent portions of a circle, such as in pie or radial charts.
section: charts
layers: [svg, canvas]
related: [components/Chart, components/Pie, examples/Arc]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Area.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Area
description: Marking component which shades the space under a line on a chart to emphasize the magnitude and trend of data over a range.
section: marks
layers: ['svg', 'canvas']
related: ['examples/Area']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/AreaChart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Streamlined Chart configuration for Area charts
description: Visualization of quantitative data over a continuous interval, with filled areas beneath a line to emphasize magnitude or cumulative values.
section: charts
layers: [svg, canvas]
related: [components/Chart, components/Area, examples/Area]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/AreaChartSimple.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Streamlined Chart configuration for Area charts
description: Streamlined visualization of quantitative data over a continuous interval, with filled areas beneath a line to emphasize magnitude or cumulative values.
section: charts
layers: [svg, canvas]
related: [components/Chart, components/Area, examples/Area]
Expand Down
1 change: 1 addition & 0 deletions docs/src/content/components/Axis.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: Commonly used component displays the scale and reference lines on a chart, providing context for interpreting data values.
section: common
layers: [svg, canvas, html]
related: [components/Grid, components/Rule]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Bar.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Bar
description: Primitive component creating individual rectangular bars to represent and compare discrete data values.
section: primitives
layers: ['svg', 'canvas']
related: ['components/Bars', 'examples/Bars', 'examples/Columns']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/BarChart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Streamlined Chart configuration for Bar charts
description: Streamlined visualization displaying categorical data using rectangular bars whose lengths represent the values of each category.
section: charts
layers: ['svg', 'canvas']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Bars.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Bars
description: Marking component which applies horizontal bars to represent and visually compare discrete data values.
section: marks
layers: ['svg', 'canvas']
related: ['components/Bar', 'examples/Bars', 'examples/Columns', 'examples/Histogram']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Blur.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Blur
description: Component applies a Gaussian blur effect to chart elements, softening their appearance for visual emphasis or stylistic purposes.
section: other
layers: ['svg']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Bounds.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Bounds
description: Component provides reactive, animated coordinate scaling for chart layouts, passing live x/y scales to its children within a shared chart context.
section: other
layers: ['svg', 'canvas']
related: ['examples/Partition', 'examples/Sunburst', 'examples/Treemap']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/BrushContext.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: BrushContext
description: Interaction component providing an interactive brush context allowing selection, adjustment, and resetting of x/y domains with draggable handles and event callbacks.
section: interactions
layers: ['svg', 'canvas']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Calendar.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Calendar
description: Marking component which highlights specific dates or time periods on a chart to emphasize events, milestones, or temporal patterns.
section: marks
layers: ['svg', 'canvas', 'html']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Chart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Sets up the chart context, defining dimension scales and supporting contexts like TooltipContext, GeoContext, and TransformContext. For simpler configuration, see prebuilt charts such as AreaChart and BarChart.
description: Base Layerchart component providing chart dimensions and contexts such as TooltipContext, GeoContext, and TransformContext. See also simplified charts such as AreaChart and BarChart for streamlined implementations.
section: charts
layers: []
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/ChartClipPath.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Convenient way to clip specific components (axis labels, etc) within chart while still allowing some to overflow (tooltips, etc)
description: Clipping component which applies a rectangular clip path for specific components (axis labels, etc) within chart while still allowing some to overflow (tooltips, etc).
section: clipping
layers: ['svg']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Circle.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: <circle> element with tweened properties using motionStore
description: Primitive component which draws a circular shape to mark specific points or emphasize data visually.
section: primitives
layers: ['svg', 'canvas', 'html']
related: ['components/Points', 'examples/Pack', 'examples/PunchCard']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/CircleClipPath.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Circular Clip Path
description: Clipping component which conditionally applies a circular clip region to its child elements based on the rendering context and provided properties.
section: clipping
layers: ['svg']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/ClipPath.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Clip Path
description: Clipping component which defines a clipping region to constrain the rendering of chart elements within a specified shape or boundary.
section: clipping
layers: ['svg']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/ColorRamp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Ramp in a color space
description: Component generates a color ramp (gradient) based on specified colors and stops, useful for mapping data values to colors in visualizations.
section: other
layers: ['svg']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Connector.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Connector
description: Primitive component which draws a line or curve between two points on a chart to illustrate relationships or connections in the data.
section: primitives
layers: ['svg', 'canvas']
related: ['components/Link', 'examples/Tree']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Dagre.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Dagre
description: Layout component which arranges directed graphs in layers, positioning nodes to minimize edge crossings and create a clear, hierarchical flow.
section: layout
layers: ['svg', 'canvas']
related: ['examples/Dagre']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Ellipse.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: <ellipse> element with tweened properties using motionStore
description: Primitive component which draws an oval shape to highlight areas, emphasize points, or decorate visual elements.
section: primitives
layers: ['svg', 'canvas', 'html']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/ForceSimulation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: ForceSimulation
description: Layout components which positions nodes using physics-based forces, simulating attraction, repulsion, and link constraints to create an intuitive, collision-free network visualization.
section: layout
layers: ['svg', 'canvas']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Frame.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Rectangle of the Chart bounding box, respects padding or full size
description: Commonly used component representing a rectangular Chart bounding box and respecting padding or full size.
section: common
layers: [svg, canvas, html]
related: [components/Rect]
Expand Down
1 change: 1 addition & 0 deletions docs/src/content/components/GeoCircle.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: Geographic component which displays circular areas on a map to represent a specific geographic region or radius around a point.
section: geo
layers: [svg, canvas]
related: [examples/Timezones]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/GeoContext.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Setup geo context, particularly the projection used by other geo components. Typically used indirectly via the `geo` prop on Chart
description: Geographic component which provides geographic projection and scaling context to children for accurate rendering of geographic data.
section: geo
layers: ['svg', 'canvas']
related: ['components/Chart']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/GeoEdgeFade.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: GeoEdgeFade
description: Geographic component which visualizes connections or flows with edges that gradually fade, emphasizing direction and intensity across a map.
section: geo
layers: ['svg', 'canvas']
related: ['examples/LoftedArcs']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/GeoPath.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: GeoPath
description: Geographic component which renders shapes such as countries, states, or regions by drawing their boundaries based on coordinate data.
section: geo
layers: ['svg', 'canvas']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/GeoPoint.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: GeoPoint
description: Geographic component which plots individual geographic locations as points on a map to visualize spatial distributions or events.
section: geo
layers: ['svg', 'canvas']
related: ['examples/GeoPoint']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/GeoSpline.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: GeoSpline
description: Geographic component which renders smooth, curved lines connecting geographic points to represent paths or flows on a map.
section: geo
layers: ['svg', 'canvas']
related: ['examples/LoftedArcs']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/GeoTile.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: GeoTile
description: Geographic component which renders map tiles in a grid supporting efficient zooming and panning for larger scale maps.
section: geo
layers: ['svg', 'canvas']
related: ['examples/GeoTile', 'examples/ZoomableTileMap']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/GeoVisible.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: GeoVisible
description: Geographic component which determines and renders only the geographic features currently within the visible map viewport to optimize performance and clarity.
section: geo
layers: ['svg', 'canvas']
related: ['examples/SubmarineCablesGlobe']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Graticule.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Graticule
description: Geographic component which overlays latitude and longitude lines on a map to provide geographic reference and context.
section: geo
layers: ['svg', 'canvas']
related: ['examples/AnimatedGlobe', 'examples/GeoProjection', 'examples/LoftedArcsGlobe']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Grid.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Draw x and/or y axis lines respecting scales
description: Commonly used component which draws horizontal and vertical lines respecting scales across a chart to enhance readability and help align data points with axis values.
section: common
layers: [svg, canvas, html]
related: [components/Axis, components/Rule]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Group.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: <g> element with convenient x/y and center placement along with tweened properties using motionStore
description: Primitive component which clusters multiple chart elements together, allowing them to be managed, styled, or transformed as a single unit.
section: primitives
layers: ['svg', 'html']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Highlight.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Highlight
description: Interaction component manages and displays tooltips allowing dynamic information to appear in response to user interactions.
section: interactions
layers: ['svg', 'canvas']
related: ['components/Tooltip', 'components/TooltipContext']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Hull.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Hull
description: Marking component which encloses a set of data points within a convex boundary to highlight clusters or groupings on a chart.
section: marks
layers: ['svg', 'canvas']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Labels.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Labels
description: Marking component which displays text directly on a chart to identify or annotate specific data points.
section: marks
layers: ['svg', 'canvas']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Legend.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# description:
description: Commonly used component which explains the symbols, colors, or patterns used in a chart, helping interpret the represented data categories. Filtering and toggling visibility of data series can be enabled for interactivity.
section: common
layers: [html]
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Line.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: <line> element with tweened properties using motionStore
description: Primitive component which draws a straight line on a chart to represent trends, connections, or boundaries between data points.
section: primitives
layers: ['svg', 'canvas', 'html']
related: ['components/Rule', 'components/Spline']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/LineChart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Streamlined Chart configuration for Line charts
description: Streamlined visualization of data points connected by lines to visualize trends or changes over time.
section: charts
layers: [svg, canvas]
related: [components/Chart, components/Spline, examples/Line]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/LinearGradient.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Linear Gradient
description: Fill component providing a linear gradient fill pattern for chart elements.
section: fill
layers: ['svg', 'canvas', 'html']
related: ['components/RadialGradient', 'components/Pattern']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Link.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Link
description: Marking component which highlights or connects specific data points on a chart to emphasize relationships or sequences.
section: marks
layers: ['svg', 'canvas']
related: ['components/Connector', 'components/Points', 'examples/Sankey', 'examples/Tree']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Marker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Graphic used for drawing arrowheads or polymarkers on Line, Spline, etc
description: Primitive component which draws visual symbols like circles, squares, or custom shapes at individual data points.
section: primitives
layers: ['svg']
related: ['components/Spline', 'components/Line', 'components/Rule', 'components/GeoSpline']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/MotionPath.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Animate an object along a path
description: Component animates an object along a specified path using configurable motion parameters such as speed, duration, and easing.
section: other
layers: ['svg']
related: ['components/Spline']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Pack.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Pack
description: Layout component which creates a space-efficient, circular layout to represent hierarchical data, where each node is depicted as a circle sized according to its value and nested within its parent node.
section: layout
layers: ['svg', 'canvas']
related: ['examples/Pack']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Partition.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Partition
description: Layout component which divides a hierarchical dataset into nested, space-filling rectangles or arcs to represent the structure and relative sizes of each node.
section: layout
layers: ['svg', 'canvas']
related: ['examples/Partition', 'examples/Sunburst']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Pattern.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Pattern
description: Fill component which provides a line or circle-based fill pattern for chart elements.
section: fill
layers: ['svg', 'canvas']
related: ['components/LinearGradient', 'components/RadialGradient']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Pie.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Pie
description: Marking component which represents data as proportional slices of a circle, showing the relative contribution of each category to the whole.
section: marks
layers: ['svg', 'canvas']
related: ['components/Arc', 'examples/Arc']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/PieChart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Streamlined Chart configuration for Pie charts
description: Streamlined visualization of data as proportional slices of a circle to represent parts of a whole.
section: charts
layers: [svg, canvas]
related: [components/Chart, components/Pie, examples/Arc]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Point.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Convenient way to translate a data item to SVG x/y coordinates
description: Primitive components which provides a convenient way to translate a data to x/y coordinates.
section: primitives
layers: ['svg', 'canvas', 'html']
related: ['examples/Area']
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Points.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Points
description: Marking component which plots individual data points on a graph to show distribution, relationships, or clusters without connecting lines.
section: marks
layers: ['svg', 'canvas']
related:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/Polygon.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Polygon
description: Primitive component which renders a multi-sided shape on a chart to represent complex areas, boundaries, or regions of interest.
section: primitives
layers: ['svg', 'canvas']
related: []
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/components/RadialGradient.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Radial Gradient
description: Fill component which provides a radial gradient fill pattern for chart elements.
section: fill
layers: ['svg']
related: ['components/LinearGradient', 'components/Pattern']
Expand Down
Loading
Loading