README
utils
Various functions used in javascript tools
- utils
- static
- .map(value, low1, high1, low2, high2) ⇒
Number
- .clamp(value, min, max) ⇒
Number
- .norm(value, start, stop) ⇒
Number
- .random([low], high) ⇒
Number
- .randomDir() ⇒
Number
- .lerp(start, stop, amt) ⇒
Number
- .lerp3(A, B, amt) ⇒
Point
- .lerpedPoints(A, B, count) ⇒
Array.<Point>
- .square(a) ⇒
Number
- .dist(A, B) ⇒
Number
- .degrees(radians) ⇒
Number
- .radians(degrees) ⇒
Number
- .intersection(c1, c2) ⇒
Array
|Boolean
- .randomName(N) ⇒
String
- .timestampName() ⇒
String
- .randomIndex(N) ⇒
Number
- .copyArray(source) ⇒
Array
- .shuffleArray(source) ⇒
Array
- .filterUnique(source) ⇒
Array
- .lerpColor(a, b, amt) ⇒
String
- .precision(value, precision) ⇒
Number
- .loadJSON(address, callback)
- .removeDiacritics(str) ⇒
String
- .splitChunks(str, n, discard) ⇒
Array
- .getQuarter(d) ⇒
Array
- .quarterExtent(quarter, year) ⇒
Array
- .downloadDataUri(options)
- .polarToCartesian(r, angle) ⇒
Point
- .cartesianToPolar(x, y) ⇒
Object
- .pageOffset(elem) ⇒
Object
- .fuzzySearch(list, searchValue) ⇒
Array
- .map(value, low1, high1, low2, high2) ⇒
- inner
- static
Number
utils.map(value, low1, high1, low2, high2) ⇒ Map a number from one range to another
Kind: static method of utils
Returns: Number
- Mapped number
Params
- value
Number
- Number to map - low1
Number
- Source range lower bound - high1
Number
- Source range upper bound - low2
Number
- Target range lower bound - high2
Number
- Target range upper bound
Number
utils.clamp(value, min, max) ⇒ Clamp a number to range
Kind: static method of utils
Returns: Number
- Clamped number
Params
- value
Number
- Number to clamp - min
Number
- Range lower bound - max
Number
- Range upper bound
Number
utils.norm(value, start, stop) ⇒ Normalize a number
Kind: static method of utils
Returns: Number
- normalized number (0.0 - 1.0)
Params
- value
Number
- value to normalize - start
Number
- Source range lower bound - stop
Number
- Source range upper bound
Number
utils.random([low], high) ⇒ Generate random number from range
Kind: static method of utils
Returns: Number
- Random number
Params
- [low]
Number
- Range lower bound - high
Number
- Range upper bound
Number
utils.randomDir() ⇒ Generate random direction (-1 or 1)
Kind: static method of utils
Returns: Number
- Random direction
Number
utils.lerp(start, stop, amt) ⇒ Linear interpolation
Kind: static method of utils
Returns: Number
- Interpolated value
Params
- start
Number
- First value - stop
Number
- Second value - amt
Number
- amount to interpolate
Point
utils.lerp3(A, B, amt) ⇒ Linear interpolation in 3D
Kind: static method of utils
Returns: Point
- Interpolated point
Params
- A
Point
- First point - B
Point
- Second point - amt
Number
- amount to interpolate
Array.<Point>
utils.lerpedPoints(A, B, count) ⇒ Linear interpolation in 3D array
Kind: static method of utils
Returns: Array.<Point>
- Interpolated points
Params
- A
Point
- First point - B
Point
- Second point - count
Number
- Point count
Number
utils.square(a) ⇒ Square
Kind: static method of utils
Returns: Number
- squared number
Params
- a
Number
- Number to square
Number
utils.dist(A, B) ⇒ Distance between two points (2D and 3D)
Kind: static method of utils
Returns: Number
- distance between the points
Params
- A
Point
- First point - B
Point
- Second point
Number
utils.degrees(radians) ⇒ Convert angle in radians to degrees
Kind: static method of utils
Returns: Number
- angle in degrees
Params
- radians
Number
- angle in radians
Number
utils.radians(degrees) ⇒ Convert angle in degrees to radians
Kind: static method of utils
Returns: Number
- angle in radians
Params
- degrees
Number
- angle in degrees
Array
| Boolean
utils.intersection(c1, c2) ⇒ Find intersection points between two circles
Kind: static method of utils
Returns: Array
| Boolean
- intersection or false (if no intersection)
Params
- c1
Circle
- first circle - c2
Circle
- second circle
String
utils.randomName(N) ⇒ Generate random name
Kind: static method of utils
Returns: String
- random name
Params
- N
Number
- length of the name
String
utils.timestampName() ⇒ Generate timestamp name
Kind: static method of utils
Returns: String
- timestamp name
Number
utils.randomIndex(N) ⇒ Generate random name
Kind: static method of utils
Returns: Number
- random index
Params
- N
Number
- max index
Array
utils.copyArray(source) ⇒ Copy array
Kind: static method of utils
Returns: Array
- array copy
Params
- source
Array
- source array
Array
utils.shuffleArray(source) ⇒ Shuffle array
Kind: static method of utils
Returns: Array
- shuffled array copy
Params
- source
Array
- source array
Array
utils.filterUnique(source) ⇒ Filter array unique
Kind: static method of utils
Returns: Array
- array with unique elements only
Params
- source
Array
- source array
String
utils.lerpColor(a, b, amt) ⇒ Linear color interpolation
Kind: static method of utils
Returns: String
- Interpolated color
Params
- a
String
- First color - b
String
- Second color - amt
Number
- amount to interpolate
Number
utils.precision(value, precision) ⇒ Round number to precision
Kind: static method of utils
Returns: Number
- rounded number
Params
- value
Number
- value to round - precision
Number
- decimal places
utils.loadJSON(address, callback)
Load JSON
Kind: static method of utils
Params
- address
String
- address of JSON to load - callback
function
- function to call on result
String
utils.removeDiacritics(str) ⇒ Remove polish diacritics
Kind: static method of utils
Returns: String
- string without diacritics
Params
- str
String
- string with diacritics
Array
utils.splitChunks(str, n, discard) ⇒ Split string to N sized chunks
Kind: static method of utils
Returns: Array
- array of string chunks
Params
- str
String
- string to split - n
Number
- chunk length - discard
Boolean
- discard chunks shorter than N
Array
utils.getQuarter(d) ⇒ Get quarter from date
Kind: static method of utils
Returns: Array
- year and quarter (1-4)
Params
- d
Date
- Date to get quarter from
Array
utils.quarterExtent(quarter, year) ⇒ Get quarter extent
Kind: static method of utils
Returns: Array
- start and end date of quarter
Params
- quarter
Number
- quarter (1-4) - year
Number
- full year
utils.downloadDataUri(options)
Download file from base64 data uri
Kind: static method of utils
Params
- options
Object
- options for the downloaded file- .data
String
- contents of the file - .filename
String
- name of the file
- .data
Point
utils.polarToCartesian(r, angle) ⇒ Convert coordinates from polar to cartesian
Kind: static method of utils
Returns: Point
- cartesian coordinates
Params
- r
Number
- radius - angle
Number
- angle
Object
utils.cartesianToPolar(x, y) ⇒ Convert coordinates from cartesian to polar
Kind: static method of utils
Returns: Object
- polar coordinates
Params
- x
Number
- x coordinate - y
Number
- y coordinate
Object
utils.pageOffset(elem) ⇒ Get element page offset
Kind: static method of utils
Returns: Object
- top and left page offset
Params
- elem
Object
- HTML element
Array
utils.fuzzySearch(list, searchValue) ⇒ Fuzzy search element in list
Kind: static method of utils
Returns: Array
- elements matching search value
Params
- list
Array
- Array of terms - searchValue
String
- search value to find
Object
utils~Point : Kind: inner typedef of utils
Properties
- x
Number
- x coordinate - y
Number
- y coordinate - z
Number
- z coordinate
Object
utils~Circle : Kind: inner typedef of utils
Properties
- x
Number
- x coordinate of the center point - y
Number
- y coordinate of the center point - r
Number
- radius
Copyright © 2022 panGenerator