https://github.com/emeeks/d3.svg.circularbrush

A brush for selecting cyclical data
https://github.com/emeeks/d3.svg.circularbrush

Last synced: 2 months ago
JSON representation

A brush for selecting cyclical data

• Host: GitHub
• URL: https://github.com/emeeks/d3.svg.circularbrush
• Owner: emeeks
• License: unlicense
• Created: 2014-12-30T21:01:09.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-12-30T22:49:26.000Z (about 9 years ago)
• Last Synced: 2024-10-31T21:22:40.247Z (3 months ago)
• Language: JavaScript
• Size: 709 KB
• Stars: 65
• Watchers: 7
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-d3 - d3.svg.circularbrush - A brush for selecting cyclical data (Utils)
• awesome-d3 - d3.svg.circularbrush - A brush for selecting cyclical data (Utils)

README

        
d3.svg.circularbrush

===============

![d3.svg.circularbrush](piebrush.gif "d3.svg.circularbrush")

`npm install d3-svg-circularbrush`

A control for selecting cyclical data. Like d3.svg.brush, it fires "brushstart", "brush" and "brushend" events when you drag the resize areas or extent. Here's an example based on a [24-hour clock](http://bl.ocks.org/emeeks/905c4691f343fc4780bd).

Here's [a more complicated example that takes advantage of `circularbrush.filter` to display radial data in a linear manner](http://bl.ocks.org/emeeks/b57f4cc89dacd38fcdcd).

**#circularbrush.range** defines the range of the brush. The domain is fixed at 0,2π, and so the range needs to be a corresponding two value array (such as [1,24] for hours of the day). Defaults to [0,2π].

**#circularbrush.innerRadius** sets the inner radius of the brush (which uses d3.svg.arc). Defaults to 50.

**#circularbrush.outerRadius** sets the outer radius of the brush (which uses d3.svg.arc). Defaults to 100.

**#circularbrush.handleSize** sets the size of the handles in radians. Defaults to .2

**#circularbrush.extent()** returns or sets the current extent of the brush based on the set **range** of the brush.

**#circularbrush.filter(_array_,_accessor_)** returns the items in the array that are within the current extent of the brush. For extents that overlap the 12 o'clock position, the earlier half of the data is inserted before the later half. This means if you've sorted your data before sending it to .filter, then it will come back sorted in the proper order for display.