du.widgets.trajectoryplot.TrajectoryPlot(name[, parent])

The trajectory plot widget class.

arg	type	description
name	string	Identifier of the widget.
parent	object	Parent element to append widget to. If not specified, widget is appended to body. optional

du.widgets.trajectoryplot.TrajectoryPlot.boundary(dim)

Sets the boundary of the area for the trajectories. Default is [0, 1, 0, 1].

arg	type	description
dim	number[]	Array containing the minimum and maximum of the x and y coordinates in the following order: [xmin, xmax, ymin, ymax]. t

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.maxLength(length)

Sets the maximum trajectory length to the specified value. Default is 10.

arg	type	description
length	number	The number of historical positions to show.

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.fadeExp(exponent)

Sets the fading exponent for the exponential fade-out of trajectories. Opacity of each trajectory segment and stop position is calculated as exp(-tau * t), where t denotes the age of the segment (relative to the age of the whole trajectory, so it is bounded in [0, 1]), and tau is the exponent. Default is 0.

arg	type	description
exponent	number	Exponent to set for trajectory fading out.

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.animate(on)

Enables animation. Default is false.

arg	type	description
on	boolean	Whether animation should be enabled or not.

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.showHead(show)

Shows current position of the entity. Default is false.

arg	type	description
show	boolean	Whether current position should be shown.

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.background(options)

Adds an image to the background of the trajectory plot. Note that the image is scaled up to fit the plot. Default is empty.

arg	type	description
options	Object	Object containing the background options. The following properties are supported: path: Path to the image file. opacity: Background opacity. Default is 1.

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.data(data)

Binds data to the trajectory plot. Expected data format: array of objects with two properties: name which is the name of the trajectory and values which is an array containing (t, x, y) objects for the trajectory points. The property t denotes the time of the position and each trajectory is sorted according to that value in ascending order (so t should have properly sortable values).

arg	type	description
data	Array	Data to plot.

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.highlight(key, duration)

Highlights the specified trajectory.

arg	type	description
key	string string[]	Single key or an array of keys of the dot group(s) to highlight.
duration	number	Duration of the highlight animation.

return	description
du.widgets.trajectoryplot.TrajectoryPlot	Reference to the current TrajectoryPlot.

du.widgets.trajectoryplot.TrajectoryPlot.addMarker(name, key, pos, size, info)

Adds a marker to the plot. A marker is a dot along with some data that is used to show on tooltips. If a marker with the specified identifier already exists, the marker is ignored.

arg	type	description
name	string	Name of the marker.
key	string	Key of the line to mark.
pos	number[]	Array containing the x and y coordinates of the marker.
size	number	Diameter of the marker.
info	Object	Object containing the title and content for the marker's tooltip.

return	description
Object	D3 selection of the marker if it could be added, null otherwise.

du.widgets.trajectoryplot.TrajectoryPlot.removeMarker(name)

Removes a marker from the plot.

arg	type	description
name	string	Name of the marker to remove.

return	description
boolean	True if marker existed and could be removed, false otherwise.

du.widgets.trajectoryplot.TrajectoryPlot.getMarkers()

Returns the name of all markers.

return	description
string[]	Array containing all marker names.