Page History

...

Example Usage	Arguments	Return Value
var button = bns.button(`div`, `id`, `gid`, `cb`, `tooltip`);	`div` - d3 selection of the div that the button will be in `id` - globally unique button ID string `gid` - the glyph ID string to be used for the button `cb` - a function reference to be executed when the button is clicked `tooltip` - (optional) string of tooltip to appear on hover	creates a button with the given information returns an object with an API (see below)
Returned API Example Usage	Arguments	Return Value
button.id; *	none	string that is the ID of the button
button.width();	none	number that is the width of the button plus padding (in pixels)

This * This API property is not a function.

...

Example Usage	Arguments	Return Value
var toggle = bns.toggle(`div`, `id`, `gid`, `initState`, `cb`, `tooltip`);	`div` - d3 selection of the div that the toggle will be in `id` - globally unique toggle ID string `gid` - the glyph ID string to be used for the toggle `initState` - whether the toggle should be "selected" or "unselected" to begin with. Truthy values will be active and falsy values will be inactive. `cb` - a function reference to be executed when the toggle is clicked. This callback ("cb") function should take an argument of the selected state of the button. `tooltip` - (optional) string of tooltip to appear on hover	creates a toggle with the given information
Returned API Example Usage	Arguments	Return Value
toggle.id *	none	string that is the ID of the toggle
toggle.width();	none	number that is the width of the toggle plus padding (in pixels)
toggle.selected();	none	boolean of the state of the toggle true - toggle is selected false - toggle is unselected
toggle.toggle();	none	this toggles the state of the button and executes `cb` with the selected state
toggle.toggleNoCb();	none	toggles the state of the button but does not execute `cb`

This * This API property is not a function.

...

Page tree