Class: DetailView

DetailView()

used to handle everything related to the detailed view handles Sigma and Fabric instances and their interplay

Constructor

new DetailView()

creates a new detail view with given settings
Source:

Methods

addSelection()

adds a new selection box
Source:

fetchScalingParams(feature, nodes) → {Object}

fetches min/max values for feature
Parameters:
Name Type Description
feature feature to be queried
nodes nodes to be checked (optional: if not present the nodes of the sigma instance are used)
Source:
Returns:
[min: max:] minima/maxima
Type
Object

getActiveSelectionIndex() → {*}

retrieves the index of the selection box which is currently selected this is the same index as the one of the related filter
Source:
Returns:
index of the currently selected filter, or -1 if none is selected
Type
*

getFabricRectangleFromSigmaCoordinates(sigmaCoordinates) → {Object}

translate from sigma coordinates to fabric rectangle
Parameters:
Name Type Description
sigmaCoordinates
Source:
Returns:
Type
Object

getFeatureCoordinatesFromSigma(sigmaRectangle) → {Object}

Translates sigma coordinates to feature coordinates by applying un/re-scaling
Parameters:
Name Type Description
sigmaRectangle rectangle of sigma coordinates
Source:
Returns:
Type
Object

getScaled(value, feature)

scale value from old interval to interval [DETAIL_MIN_VAL, DETAIL_MAX_VAL]
Parameters:
Name Type Description
value original feature-value to be fitted into sigma-space
feature feature for which the value should be scaled
Source:
Returns:
number position in interval

getSigmaCoordinatesFromFabric(fbSelectionRectangle) → {Object}

translate from fabric canvas coordinates to sigma coordinates
Parameters:
Name Type Description
fbSelectionRectangle
Source:
Returns:
Type
Object

getSigmaCoordinatesFromFeature(featureRectangle) → {Object}

Translates feature coordinates to sigma coordinates by applying scaling
Parameters:
Name Type Description
featureRectangle rectangle of feature coordinates
Source:
Returns:
Type
Object

getUnscaled(scaledValue, feature) → {number}

revert scaling from [DETAIL_MIN_VAL, DETAIL_MAX_VAL] to old interval
Parameters:
Name Type Description
scaledValue value from sigma-space to be converted back to original feature space
feature feature for which the value should be unscaled
Source:
Returns:
Type
number

initDetailSelectionCanvas()

inits the fabric canvas which is used to create selection rectangles and also inits the transmission of mouse events to the sigma canvas
Source:

initDimensionSwitcher(node)

inits detail-view box toggle enables users to switch dimensions
Parameters:
Name Type Description
node node used to check available dimensions
Source:

initSigma(container_id, panel_id, use_web_gl)

create new sigma instance at startup do not show edges do prevent cluttering
Parameters:
Name Type Description
container_id id of div where detail graph should be displayed
panel_id id of the bootstrap panel wrapping the container
use_web_gl if true, webgl is used for rendering (keep in mind that less functionality is supported)
Source:

readEdges(file, progress_div, edge_id_col, source_node_col, target_node_col)

reads in all edges from the specified JSON-File and reports progress to a supplied div
Parameters:
Name Type Description
file path to the JSON-file to be loaded
progress_div a jquery-element that displays the current progress
edge_id_col column name from file used as ID
source_node_col column name from file used as source element
target_node_col column name from file used as target element
Source:

readNodes(file, node_id_col, x_axis, y_axis, callback_function)

read in all nodes from the specified JSON-file and sets default axis
Parameters:
Name Type Description
file path to the JSON-file to be loaded
node_id_col column name from file used as ID
x_axis column name from file used as horizontal axis
y_axis column name from file used as vertical axis
callback_function function to be executed as soon as loading finishes
Source:

recalcColoring(nodeBoxResult, edgeBoxResult)

colors all mapped nodes and edges to the respective color of the filter
Parameters:
Name Type Description
nodeBoxResult result of filter search [containing 'mapped' & 'unmapped' nodes]
edgeBoxResult result of filter search [containing 'mapped' & 'unmapped' edges]
Source:

recalcEdgeColoring(boxResult, refresh)

colors all mapped edges to the respective color of the filter
Parameters:
Name Type Default Description
boxResult result of filter search [containing 'mapped' & 'unmapped' edges]
refresh false if true the sigma graph is updated
Source:

recalcNodeColoring(boxResult, refresh)

colors all mapped nodes to the respective color of the filter
Parameters:
Name Type Default Description
boxResult result of filter search [containing 'mapped' & 'unmapped' nodes]
refresh false if true the sigma graph is updated
Source:

recalcSelectionBoxes(idx, nodeFilterMap)

Change selection boxes in detail view according to supplied filters This can be used to keep selection boxes up to date with filter changes from outside
Parameters:
Name Type Description
idx index of the rectangle to be changed
nodeFilterMap all node filters of the related filter
Source:

removeActiveSelection()

removes the currently selected box in the detail view does nothing if no box is selected
Source:

setCameraToCenter()

positions sigma camera to the center of our scale and removes scaling
Source:

setSelectionColor(idx, color)

changes the color for a selection rectangle
Parameters:
Name Type Description
idx index of the respective selection rectangle
color new color for the selection rectangle
Source:

setXDimension(feature_name)

sets the active x-dimension for the detail view changes the positions of all nodes and selection boxes
Parameters:
Name Type Description
feature_name feature to be used as new x-axis
Source:

setYDimension(feature_name)

sets the active y-dimension for the detail view changes the positions of all nodes and selection boxes
Parameters:
Name Type Description
feature_name feature to be used as new y-axis
Source:

switchFilterRectangles(filterIdx1, filterIdx2)

switches filter order for the supplied two indices order of supplied filters is irrelevant
Parameters:
Name Type Description
filterIdx1 index of a filter
filterIdx2 index of a filter
Source: