d3plus-shape

Fancy SVG shapes for visualizations

Installing

If using npm, npm install d3plus-shape. Otherwise, you can download the latest release from GitHub or load from a CDN.

import modules from "d3plus-shape";

d3plus-shape can be loaded as a standalone library or bundled as part of D3plus. ES modules, AMD, CommonJS, and vanilla environments are supported. In vanilla, a d3plus global is exported:

<script src="https://cdn.jsdelivr.net/npm/d3plus-shape@1"></script>
<script>
  console.log(d3plus);
</script>

Examples

Live examples can be found on d3plus.org, which includes a collection of example visualizations using d3plus-react. These examples are powered by the d3plus-storybook repo, and PRs are always welcome. 🍻

largestRect - An angle of zero means that the longer side of the polygon (the width) will be aligned with the x axis. An angle of 90 and/or -90 means that the longer side of the polygon (the width) will be aligned with the y axis. The value can be a number between -90 and 90 specifying the angle of rotation of the polygon, a string which is parsed to a number, or an array of numbers specifying the possible rotations of the polygon.
lineIntersection - Finds the intersection point (if there is one) of the lines p1q1 and p2q2.
path2polygon - Transforms a path string into an Array of points.
pointDistance - Calculates the pixel distance between two points.
pointDistanceSquared - Returns the squared euclidean distance between two points.
pointRotate - Rotates a point around a given origin.
polygonInside - Checks if one polygon is inside another polygon.
polygonRayCast - Gives the two closest intersection points between a ray cast from a point inside a polygon. The two points should lie on opposite sides of the origin.
polygonRotate - Rotates a point around a given origin.
segmentBoxContains - Checks whether a point is inside the bounding box of a line segment.
segmentsIntersect - Checks whether the line segments p1q1 && p2q2 intersect.
shapeEdgePoint - Calculates the x/y position of a point at the edge of a shape, from the center of the shape, given a specified pixel distance and radian angle.
largestRect - Simplifies the points of a polygon using both the Ramer-Douglas-Peucker algorithm and basic distance-based simplification. Adapted to an ES6 module from the excellent Simplify.js.

LargestRect - The returned Object of the largestRect function.

Image <>

This is a global class.

Image
- new Image()
- .render([callback]) ↩︎
- .data([data]) ↩︎
- .duration([ms]) ↩︎
- .height([value]) ↩︎
- .id([value]) ↩︎
- .opacity([value]) ↩︎
- .pointerEvents([value]) ↩︎
- .select([selector]) ↩︎
- .url([value]) ↩︎
- .width([value]) ↩︎
- .x([value]) ↩︎
- .y([value]) ↩︎

# new Image()

Creates SVG images based on an array of data.

a sample row of data

var data = {"url": "file.png", "width": "100", "height": "50"};

passed to the generator

new Image().data([data]).render();

creates the following

<image class="d3plus-Image" opacity="1" href="file.png" width="100" height="50" x="0" y="0"></image>

this is shorthand for the following

image().data([data])();

which also allows a post-draw callback function

image().data([data])(function() { alert("draw complete!"); })

# Image.render([callback]) <>

Renders the current Image to the page. If a callback is specified, it will be called once the images are done drawing.

This is a static method of Image, and is chainable with other methods of this Class.

# Image.data([data]) <>

If data is specified, sets the data array to the specified array and returns the current class instance. If data is not specified, returns the current data array. An tag will be drawn for each object in the array.

This is a static method of Image, and is chainable with other methods of this Class.

# Image.duration([ms]) <>

If ms is specified, sets the animation duration to the specified number and returns the current class instance. If ms is not specified, returns the current animation duration.

This is a static method of Image, and is chainable with other methods of this Class.

# Image.height([value]) <>

If value is specified, sets the height accessor to the specified function or number and returns the current class instance.

This is a static method of Image, and is chainable with other methods of this Class.

function(d) {
  return d.height;
}

# Image.id([value]) <>

If value is specified, sets the id accessor to the specified function and returns the current class instance.

This is a static method of Image, and is chainable with other methods of this Class.

function(d) {
  return d.id;
}

# Image.opacity([value]) <>

Sets the opacity of the image.

This is a static method of Image, and is chainable with other methods of this Class.

# Image.pointerEvents([value]) <>

If value is specified, sets the pointer-events accessor to the specified function or string and returns the current class instance.

This is a static method of Image, and is chainable with other methods of this Class.

# Image.select([selector]) <>

If selector is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If selector is not specified, returns the current SVG container element.

This is a static method of Image, and is chainable with other methods of this Class.

# Image.url([value]) <>

If value is specified, sets the URL accessor to the specified function and returns the current class instance.

This is a static method of Image, and is chainable with other methods of this Class.

function(d) {
  return d.url;
}

# Image.width([value]) <>

If value is specified, sets the width accessor to the specified function or number and returns the current class instance.

This is a static method of Image, and is chainable with other methods of this Class.

function(d) {
  return d.width;
}

# Image.x([value]) <>

If value is specified, sets the x accessor to the specified function or number and returns the current class instance.

This is a static method of Image, and is chainable with other methods of this Class.

function(d) {
  return d.x || 0;
}

# Image.y([value]) <>

If value is specified, sets the y accessor to the specified function or number and returns the current class instance.

This is a static method of Image, and is chainable with other methods of this Class.

function(d) {
  return d.y || 0;
}

Area <>

This is a global class, and extends all of the methods and functionality of Shape.

Area ⇐ Shape
- new Area()
- .render([callback]) ↩︎
- .curve([value]) ↩︎
- .defined([value]) ↩︎
- .x([value]) ↩︎
- .x0([value]) ↩︎
- .x1([value]) ↩︎
- .y([value]) ↩︎
- .y0([value]) ↩︎
- .y1([value]) ↩︎

# new Area()

Creates SVG areas based on an array of data.

# Area.render([callback]) <>

Draws the area polygons.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.curve([value]) <>

If value is specified, sets the area curve to the specified string and returns the current class instance. If value is not specified, returns the current area curve.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.defined([value]) <>

If value is specified, sets the defined accessor to the specified function and returns the current class instance. If value is not specified, returns the current defined accessor.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.x([value]) <>

If value is specified, sets the x accessor to the specified function or number and returns the current class instance. If value is not specified, returns the current x accessor.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.x0([value]) <>

If value is specified, sets the x0 accessor to the specified function or number and returns the current class instance. If value is not specified, returns the current x0 accessor.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.x1([value]) <>

If value is specified, sets the x1 accessor to the specified function or number and returns the current class instance. If value is not specified, returns the current x1 accessor.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.y([value]) <>

If value is specified, sets the y accessor to the specified function or number and returns the current class instance. If value is not specified, returns the current y accessor.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.y0([value]) <>

If value is specified, sets the y0 accessor to the specified function or number and returns the current class instance. If value is not specified, returns the current y0 accessor.

This is a static method of Area, and is chainable with other methods of this Class.

# Area.y1([value]) <>

If value is specified, sets the y1 accessor to the specified function or number and returns the current class instance. If value is not specified, returns the current y1 accessor.

This is a static method of Area, and is chainable with other methods of this Class.

Bar <>

This is a global class, and extends all of the methods and functionality of Shape.

Bar ⇐ Shape
- new Bar()
- .render([callback]) ↩︎
- .height([value]) ↩︎
- .width([value]) ↩︎
- .x0([value]) ↩︎
- .x1([value]) ↩︎
- .y0([value]) ↩︎
- .y1([value]) ↩︎

# new Bar()

Creates SVG areas based on an array of data.

# Bar.render([callback]) <>

Draws the bars.

This is a static method of Bar, and is chainable with other methods of this Class.

# Bar.height([value]) <>

If value is specified, sets the height accessor to the specified function or number and returns the current class instance.

This is a static method of Bar, and is chainable with other methods of this Class.

function(d) {
  return d.height;
}

# Bar.width([value]) <>

If value is specified, sets the width accessor to the specified function or number and returns the current class instance.

This is a static method of Bar, and is chainable with other methods of this Class.

function(d) {
  return d.width;
}

# Bar.x0([value]) <>

If value is specified, sets the x0 accessor to the specified function or number and returns the current class instance.

This is a static method of Bar, and is chainable with other methods of this Class.

# Bar.x1([value]) <>

If value is specified, sets the x1 accessor to the specified function or number and returns the current class instance.

This is a static method of Bar, and is chainable with other methods of this Class.

# Bar.y0([value]) <>

If value is specified, sets the y0 accessor to the specified function or number and returns the current class instance.

This is a static method of Bar, and is chainable with other methods of this Class.

# Bar.y1([value]) <>

If value is specified, sets the y1 accessor to the specified function or number and returns the current class instance.

This is a static method of Bar, and is chainable with other methods of this Class.

Box <>

This is a global class, and extends all of the methods and functionality of BaseClass.

Box ⇐ BaseClass
- new Box()
- .render([callback]) ↩︎
- .active([value]) ↩︎
- .data([data]) ↩︎
- .hover([value]) ↩︎
- .medianConfig([value]) ↩︎
- .orient([value]) ↩︎
- .outlier(_) ↩︎
- .outlierConfig([value]) ↩︎
- .rectConfig([value]) ↩︎
- .rectWidth([value]) ↩︎
- .select([selector]) ↩︎
- .whiskerConfig([value]) ↩︎
- .whiskerMode([value]) ↩︎
- .x([value]) ↩︎
- .y([value]) ↩︎

# new Box()

Creates SVG box based on an array of data.

# Box.render([callback]) <>

Draws the Box.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.active([value]) <>

Sets the highlight accessor to the Shape class's active function.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.data([data]) <>

If data is specified, sets the data array to the specified array and returns the current class instance. If data is not specified, returns the current data array.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.hover([value]) <>

Sets the highlight accessor to the Shape class's hover function.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.medianConfig([value]) <>

If value is specified, sets the config method for median and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.orient([value]) <>

If value is specified, sets the orientation to the specified value. If value is not specified, returns the current orientation.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.outlier(_) <>

If value is specified, sets the outlier accessor to the specified function or string and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.outlierConfig([value]) <>

If value is specified, sets the config method for each outlier point and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.rectConfig([value]) <>

If value is specified, sets the config method for rect shape and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.rectWidth([value]) <>

If value is specified, sets the width accessor to the specified function or number and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

function(d) {
  return d.width;
}

# Box.select([selector]) <>

This is a static method of Box, and is chainable with other methods of this Class.

# Box.whiskerConfig([value]) <>

If value is specified, sets the config method for whisker and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.whiskerMode([value]) <>

Determines the value used for each whisker. Can be passed a single value to apply for both whiskers, or an Array of 2 values for the lower and upper whiskers (in that order). Accepted values are "tukey", "extent", or a Number representing a quantile.

This is a static method of Box, and is chainable with other methods of this Class.

# Box.x([value]) <>

If value is specified, sets the x axis to the specified function or number and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

function(d) {
  return d.x;
}

# Box.y([value]) <>

If value is specified, sets the y axis to the specified function or number and returns the current class instance.

This is a static method of Box, and is chainable with other methods of this Class.

function(d) {
  return d.y;
}

Circle <>

This is a global class, and extends all of the methods and functionality of Shape.

Circle ⇐ Shape
- new Circle()
- .render([callback]) ↩︎
- .r([value]) ↩︎

# new Circle()

Creates SVG circles based on an array of data.

# Circle.render([callback]) <>

Draws the circles.

This is a static method of Circle, and is chainable with other methods of this Class.

# Circle.r([value]) <>

If value is specified, sets the radius accessor to the specified function or number and returns the current class instance.

This is a static method of Circle, and is chainable with other methods of this Class.

function(d) {
  return d.r;
}

Line <>

This is a global class, and extends all of the methods and functionality of Shape.

Line ⇐ Shape
- new Line()
- .render([callback]) ↩︎
- .curve([value]) ↩︎
- .defined([value]) ↩︎

# new Line()

Creates SVG lines based on an array of data.

# Line.render([callback]) <>

Draws the lines.

This is a static method of Line, and is chainable with other methods of this Class.

# Line.curve([value]) <>

If value is specified, sets the area curve to the specified string and returns the current class instance. If value is not specified, returns the current area curve.

This is a static method of Line, and is chainable with other methods of this Class.

# Line.defined([value]) <>

If value is specified, sets the defined accessor to the specified function and returns the current class instance. If value is not specified, returns the current defined accessor.

This is a static method of Line, and is chainable with other methods of this Class.

Path <>

This is a global class, and extends all of the methods and functionality of Shape.

Path ⇐ Shape
- new Path()
- .render([callback]) ↩︎
- .d([value]) ↩︎

# new Path()

Creates SVG Paths based on an array of data.

# Path.render([callback]) <>

Draws the paths.

This is a static method of Path, and is chainable with other methods of this Class.

# Path.d([value]) <>

If value is specified, sets the "d" attribute accessor to the specified function or number and returns the current class instance.

This is a static method of Path, and is chainable with other methods of this Class.

function(d) {
  return d.path;
}

Rect <>

This is a global class, and extends all of the methods and functionality of Shape.

Rect ⇐ Shape
- new Rect()
- .render([callback]) ↩︎
- .height([value]) ↩︎
- .width([value]) ↩︎

# new Rect()

Creates SVG rectangles based on an array of data. See this example for help getting started using the rectangle generator.

# Rect.render([callback]) <>

Draws the rectangles.

This is a static method of Rect, and is chainable with other methods of this Class.

# Rect.height([value]) <>

If value is specified, sets the height accessor to the specified function or number and returns the current class instance.

This is a static method of Rect, and is chainable with other methods of this Class.

function(d) {
  return d.height;
}

# Rect.width([value]) <>

If value is specified, sets the width accessor to the specified function or number and returns the current class instance.

This is a static method of Rect, and is chainable with other methods of this Class.

function(d) {
  return d.width;
}

Shape <>

This is a global class, and extends all of the methods and functionality of BaseClass.

Shape ⇐ BaseClass
- new Shape()
- .render([callback]) ↩︎
- .active([value]) ↩︎
- .activeOpacity(value) ↩︎
- .activeStyle(value) ↩︎
- .ariaLabel(value) ↩︎
- .backgroundImage([value]) ↩︎
- .data([data]) ↩︎
- .discrete(value) ↩︎
- .duration([ms]) ↩︎
- .fill([value]) ↩︎
- .fillOpacity([value]) ↩︎
- .hover([value]) ↩︎
- .hoverStyle(value) ↩︎
- .hoverOpacity([value]) ↩︎
- .hitArea([bounds]) ↩︎
- .id([value]) ↩︎
- .label([value]) ↩︎
- .labelBounds([bounds]) ↩︎
- .labelConfig([value]) ↩︎
- .opacity([value]) ↩︎
- .pointerEvents([value]) ↩︎
- .role(value) ↩︎
- .rotate([value]) ↩︎
- .rx([value]) ↩︎
- .ry([value]) ↩︎
- .scale([value]) ↩︎
- .select([selector]) ↩︎
- .shapeRendering([value]) ↩︎
- .sort([value]) ↩︎
- .stroke([value]) ↩︎
- .strokeDasharray([value]) ↩︎
- .strokeLinecap([value]) ↩︎
- .strokeOpacity([value]) ↩︎
- .strokeWidth([value]) ↩︎
- .textAnchor([value]) ↩︎
- .texture([value]) ↩︎
- .textureDefault([value]) ↩︎
- .vectorEffect([value]) ↩︎
- .verticalAlign([value]) ↩︎
- .x([value]) ↩︎
- .y([value]) ↩︎

# new Shape()

An abstracted class for generating shapes.

# Shape.render([callback]) <>

Renders the current Shape to the page. If a callback is specified, it will be called once the shapes are done drawing.