API Docs for:
Show:

utils.nf.graph-event Class

Extends Graph-position
Defined in: addon/utils/nf/graph-event.js:3
Module: utils/nf/array-helpers

Event object for graph events

Methods

identity

(
  • x
)
Any private

Defined in addon/utils/nf/array-helpers.js:5

returns whatever you pass into it.

Parameters:

  • x Any

Returns:

Any:

x

natualSort

(
  • arr
)

Defined in addon/utils/nf/array-helpers.js:112

Sorts the array "naturally". Meaning taking into account both alphabetical and numeric sorting within strings.

Parameters:

  • arr Array

    the array to sort

naturalCompare

(
  • a
  • b
)
Number

Defined in addon/utils/nf/array-helpers.js:77

A JavaScript sorting predicate for natural sorting.

Parameters:

  • a Any

    the value to compare to b

  • b Any

    the value to compare to a

Returns:

Number:

-1, 0 or 1 if a is less than, equal to, or greater than b, respectively.

naturalTokenize

(
  • item
)
Array private

Defined in addon/utils/nf/array-helpers.js:59

breaks a string into an array of tokens in preparation for natural comparison and sorting.

Parameters:

  • item String

    the value to tokenize

Returns:

Array:

an array of tokens found in the item

nearestIndexTo

(
  • arr
  • val
  • mappingFn
)

Defined in addon/utils/nf/array-helpers.js:16

Performs a binary search on the array and finds the nearest index to the value passed.

Parameters:

  • arr Array

    the sorted array to search.

  • val Number

    the value to find the nearest index to.

  • mappingFn Function

    an optional function for pulling values out of the array items.

Properties

data

Any

Defined in addon/utils/nf/graph-event.js:18

A data value passed with the event

Default: null

originalEvent

Event

Defined in addon/utils/nf/graph-event.js:10

The original event that triggered this event or action

Default: null