Nomogram

Nomogram

Kind: global class

• Nomogram
  • .draw()
  • .resize()
  • .data(data)
  • .setAxes([axes], [axesMode], [shrinkMode])
  • .target([targetID])
  • .size([size])
  • .brushable(brushable)
  • .color([color])
  • .strokeWidth([width])
  • .opacity([opacity])
  • .filteredOpacity([opacity])
  • .margins([margins])
  • .titlePosition([position])
  • .onMouseOver(preset, [fnc])
  • .onMouseOut(preset, [fnc])
  • .titleFontSize([size])
  • .titleRotation([size])
  • .tickFontSize([size])

nomogram.draw()

Draw the nomogram

Kind: instance method of Nomogram

nomogram.resize()

Resize the nomogram based on either the specific size in plotSize, or target

Kind: instance method of Nomogram

nomogram.data(data)

Set the data that will be used in the plots

Kind: instance method of Nomogram

Param	Type	Description
data	array	The data to be used in the plots

nomogram.setAxes([axes], [axesMode], [shrinkMode])

Set the axes of the data that will be drawn

Kind: instance method of Nomogram

Param	Type	Default	Description
[axes]	array		An array of axes to be used
[axesMode]	string	"reduce"	The mode which the custom axes is using "alter" or "reduce"
[shrinkMode]	string	"shrinkAxis"	The mode which the custom axes is using "shrinkAxis" or "shrinkRange"

nomogram.target([targetID])

Set the target element which the SVG will be appended to for drawing

Kind: instance method of Nomogram

Param	Type	Default	Description
[targetID]	string	"body"	The ID of the nomogram drawing target location

nomogram.size([size])

Set a specific size for the nomogram

Kind: instance method of Nomogram

Param	Type	Description
[size]	object	The size of the plots
size.width	object	The width for the plots
size.height	object	The height for the plots

nomogram.brushable(brushable)

Set brushable flag deciding if the nomogram should be brushable or not

Kind: instance method of Nomogram

Param	Type	Description
brushable	boolean	true/false if the nomogram will be brushable

nomogram.color([color])

Set a method or color value for each nomogram line based on data and index of line

Kind: instance method of Nomogram

Param	Type	Default	Description
[color]	function	"lightblue"	Function defining how to color each line

nomogram.strokeWidth([width])

Set a method or width for each nomogram line stroke-width based on data and index of line

Kind: instance method of Nomogram

Param	Type	Default	Description
[width]	number	1	Value or function defining how wide each line is

nomogram.opacity([opacity])

Set a method or value for each nomogram line opacity based on data and index of line

Kind: instance method of Nomogram

Param	Type	Default	Description
[opacity]	number	1	Value or function [0,1] defining how opaque each line is

nomogram.filteredOpacity([opacity])

Set a method or value for each nomogram line opacity based on data and index of line when filter is applied to lines This is the opacity of lines which are outside of the filter

Kind: instance method of Nomogram

Param	Type	Default	Description
[opacity]	number	0.1	Value or function [0,1] defining how opaque each line is when filter applied

nomogram.margins([margins])

Set the margins around the nomogram within the drawing space

Kind: instance method of Nomogram

Param	Type	Default	Description
[margins]	object	{top: 50, bottom: 20, left: 30, right: 30}	Object specifying margins

nomogram.titlePosition([position])

Set the location of axis titles

Kind: instance method of Nomogram

Param	Type	Default	Description
[position]	string	"top"	Position of titles "top", or "bottom"

nomogram.onMouseOver(preset, [fnc])

Set the location of axis titles

Kind: instance method of Nomogram

Param	Type	Description
preset	string	Choice of a preset function or custom
[fnc]	function	Function defining behavior on "mouseover" of lines

nomogram.onMouseOut(preset, [fnc])

Set the location of axis titles

Kind: instance method of Nomogram

Param	Type	Description
preset	string	Choice of a preset function or custom
[fnc]	function	Function defining behavior on "mouseout" of lines

nomogram.titleFontSize([size])

Set the title font size for the axes

Kind: instance method of Nomogram

Param	Type	Default	Description
[size]	number	10	Size of axis title font

nomogram.titleRotation([size])

Set the axis title rotation

Kind: instance method of Nomogram

Param	Type	Default	Description
[size]	number	10	Size of axis title font

nomogram.tickFontSize([size])

Set the tick font size for the axes

Kind: instance method of Nomogram

Param	Type	Default	Description
[size]	number	8	Size of axis tick font