API Docs for:
Show:

components.nf-dot Class

Plots a circle at a given x and y domain value on an nf-graph.

Methods

_trackedDataChanged

() private

Observes changes to tracked data and sends the didTrack action.

init

()

Initalization method that gets the nf-graph parent and assigns it to graph NOTE: all object that mixin and have init, must call super.init()

Properties

cx

Number private

The computed center x coordinate of the circle

cy

Number private

The computed center y coordinate of the circle

didTrack

String

The action to send on didTrack.

Default: null

graph

components.nf-graph

The parent graph for a component.

Default: null

hoverData

Object an object with the following values: - point: an x, y pair for the exact px coordinates inside the graph-content - graphX: domain x value at mouse position - graphY: domain y value at mouse position - x: nearest x data value - y: nearest y data value - data: nearest raw data - renderX: domain x value to render a tracking dot at (stacked areas are offset) - renderY: domain x value to render a tracking dot at (stacked areas are offset) - mouseX: mouse x position in pixels - mouseY: mouse y position in pixels

The value of the data that is being tracked by the component, ONLY if the graph-content is currently being hovered.

Default: null

isVisible

Unknown private

Toggles the visibility of the dot. If x or y are not numbers, will return false.

r

Number

The radius of the circle plotted

Default: 2.5

scaleOffsetX

Number

The offset, in pixels, for the x scale

Default: 0

scaleOffsetY

Number

The offset, in pixels, for the y scale

Default: 0

scaleZoomX

Number

The zoom multiplier for the x scale

Default: 1

scaleZoomY

Number

The zoom multiplier for the y scale

Default: 1

showTrackingDot

Boolean

Gets or sets whether the tracking dot should be shown at all.

Default: true

trackedData

Object an object with the following values: - point: an x, y pair for the exact px coordinates inside the graph-content - graphX: domain x value at mouse position - graphY: domain y value at mouse position - x: nearest x data value - y: nearest y data value - data: nearest raw data - renderX: domain x value to render a tracking dot at (stacked areas are offset) - renderY: domain x value to render a tracking dot at (stacked areas are offset) - mouseX: mouse x position in pixels - mouseY: mouse y position in pixels

The value of the data that is being tracked by the component.

Default: null

trackingDotRadius

Number

The radius of the tracking dot in pixels

Default: 2.5

trackingMode

String

Gets or sets the tracking mode of the component.

Possible values are:

  • 'none': no tracking behavior
  • 'hover': only track while mouse hover
  • 'snap-last': track while mouse hover, but snap to the last data element when not hovering
  • 'snap-first': track while mouse hover, but snap to the first data element when not hovering
  • 'selected-hover': The same as 'hover' tracking mode, but only when the compononent is selected
  • 'selected-snap-last': The same as 'snap-last' tracking mode, but only when the compononent is selected
  • 'selected-snap-first': The same as 'snap-first' tracking mode, but only when the compononent is selected

Default: 'none'

x

Number

The y domain value at which to plot the circle

Default: null

x

Number

The x domain value at which to plot the circle

Default: null

xScale

d3.scale

The x scale used by this component

yScale

d3.scale

The y scale used by this component