@labvis-ufpa/vistechlib (master) doxdox documentation

Information Visualization Technique Library

# BarChart(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# BeeswarmPlot(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# CirclePacking(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# Histogram(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# ParallelBundling(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# ParallelCoordinates(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# PieChart(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# ScatterplotMatrix(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# Sunburst(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# Treemap(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# module.exports.define_layout_positions(width)

Parameters

Name Types Description
width string - width display

# module.exports.lineIntersects(a, b, c, d, p, q, r, s)

Parameters

Name Types Description
a x0 line1
b y0 line1
c x1 line1
d y0 line1
p x0 line2
q y0 line2
r x1 line2
s y2 line2

# module.exports.reduce_and_count(domainInput)

Parameters

Name Types Description
domainInput string - Data domain

# ...args(element, args)

Parameters

Name Types Description
element object - data element with itens
args array - variable that can be used for other attributes like data = d, index = i, color etc ..

# ...args(element, args)

Parameters

Name Types Description
element object - data element in visualization
args array - variable that can be used for other attributes like data = d, index = i, color etc ..

# ...args(args)

Parameters

Name Types Description
args array<string> - array with text values

# _bindDataMouseEvents(selection, prefix)

Parameters

Name Types Description
selection string - bind interaction that will be available
prefix object - selected element date and index

# annotate(svgElement)

Parameters

Name Types Description
svgElement object - svg element where annotation can be added

# clearAnnotations()

# constructor(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# data(d)

Parameters

Name Types Description
d - dataset in json format

# filterByDimension()

# getColor()

# getHighlightElement(i)

Parameters

Name Types Description
i number - view element index

# getSelected()

# hierarchy()

# on(e, fun)

Parameters

Name Types Description
e string - event selected exemple: dataclick
fun string - callback function with desired behavior

# orderByDimension()

# redraw()

# removeComments()

# removeSelect()

# resize()

# select(elems)

Parameters

Name Types Description
elems array<object> - elements which should be selected in the visualization

# setColor(color)

Parameters

Name Types Description
color string - cor em hexadecimal, rbg , ou string

# setInteractionMode(flag)

Parameters

Name Types Description
flag boolean - flag to enable and disable invisible layer

# this.annotations()

# this.background()

# this.event()

@description dispatch event available for visualization elements, where it will be active when using outside the library this.event() brush * draw * highlightstart * highlightend * datamouseover * datamouseout * dataclick * datadblclick * ancestormouseover * ancestormouseout * ancestorclick * ancestordblclick * dimensiontitleclick * datacanvasmouseup * datacanvasmousemove * datacanvasmousedown

# this.foreground()

# this.highlightLayer()

# this.interactionLayer()

# this.overlay()

# this.selectionLayer()

# this.svg()

# this.visContentHeight()

# this.visContentWidth()

# ...args(element, args)

Parameters

Name Types Description
element object - data element with itens
args array - variable that can be used for other attributes like data = d, index = i, color etc ..

# ...args(element, args)

Parameters

Name Types Description
element object - data element in visualization
args array - variable that can be used for other attributes like data = d, index = i, color etc ..

# ...args(args)

Parameters

Name Types Description
args array<string> - array with text values

# _bindDataMouseEvents(selection, prefix)

Parameters

Name Types Description
selection string - bind interaction that will be available
prefix object - selected element date and index

# annotate(svgElement)

Parameters

Name Types Description
svgElement object - svg element where annotation can be added

# BarChart(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# BeeswarmPlot(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# CirclePacking(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# clearAnnotations()

# constructor(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# data(d)

Parameters

Name Types Description
d - dataset in json format

# filterByDimension()

# getColor()

# getHighlightElement(i)

Parameters

Name Types Description
i number - view element index

# getSelected()

# hierarchy()

# Histogram(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# inspect()

Return a human readable representation of a moment that can also be evaluated to get a new moment which is the same

# module.exports.define_layout_positions(width)

Parameters

Name Types Description
width string - width display

# module.exports.lineIntersects(a, b, c, d, p, q, r, s)

Parameters

Name Types Description
a x0 line1
b y0 line1
c x1 line1
d y0 line1
p x0 line2
q y0 line2
r x1 line2
s y2 line2

# module.exports.reduce_and_count(domainInput)

Parameters

Name Types Description
domainInput string - Data domain

# on(e, fun)

Parameters

Name Types Description
e string - event selected exemple: dataclick
fun string - callback function with desired behavior

# orderByDimension()

# ParallelBundling(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# ParallelCoordinates(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# PieChart(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# redraw()

# removeComments()

# removeSelect()

# resize()

# ScatterplotMatrix(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# select(elems)

Parameters

Name Types Description
elems array<object> - elements which should be selected in the visualization

# setColor(color)

Parameters

Name Types Description
color string - cor em hexadecimal, rbg , ou string

# setInteractionMode(flag)

Parameters

Name Types Description
flag boolean - flag to enable and disable invisible layer

# Sunburst(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object

# this.annotations()

# this.background()

# this.event()

@description dispatch event available for visualization elements, where it will be active when using outside the library this.event() brush * draw * highlightstart * highlightend * datamouseover * datamouseout * dataclick * datadblclick * ancestormouseover * ancestormouseout * ancestorclick * ancestordblclick * dimensiontitleclick * datacanvasmouseup * datacanvasmousemove * datacanvasmousedown

# this.foreground()

# this.highlightLayer()

# this.interactionLayer()

# this.overlay()

# this.selectionLayer()

# this.svg()

# this.visContentHeight()

# this.visContentWidth()

# Treemap(parentElement, )

Parameters

Name Types Description
parentElement string - Parent element where view will be added
object