Skip to content

functions.md

Latest commit

 

History

History
254 lines (166 loc) · 9.33 KB

functions.md

File metadata and controls

254 lines (166 loc) · 9.33 KB
Raw

Functions

beforeOpacity

Calculates before opacity color value producing color you need after applying opacity.

Returns: string - the hex color before opacity

Param Type Default Description
color string `` The color you want to get after applying opacity.
opacity number `` Opacity

binarySearch

Search sorted list of elements for the nearest item.

Returns: BinarySearchResult - returns an item of the collection, which is nearest to optimal measured by callback function

Param Type Default Description
items Object[] `` - The collection of elements.
callback funcDistance `` - A callback function to get distance for the collection item.
startMinimum number undefined - The minimum index in the array to start search from
startMaximum number undefined - The maximum index in the array to start search from
Callbacks

funcDistance(item, index)

Callback for finding distance for a collection item

Returns: number - returns a distance for the item

Param Type Default Description
item Object `` A collection item
index number `` An index of the collection item

compareArrays

Compares non-sorted arrays.

Returns: boolean - returns true if the arrays are identical.

Param Type Default Description
array1 Object[] `` - The first collection of elements.
array2 Object[] `` - The second collection of elements.
getKeyFunc getKeyFuncCallback, undefined `` If callback function is defined it is used to get a key for an array element
Callbacks

getKeyFuncCallback(item)

Callback for getting item key for an element of the array

Returns: number - returns key of the item

Param Type Default Description
item Object `` A collection item

getBlue

Gets blue value of HEX color string.

Returns: number - returns blue value of the hex color string.

Param Type Default Description
color string `` Color

getColorHexValue

Converts color string into HEX color string.

Returns: string - returns color value in form of hex string.

Param Type Default Description
color string `` Regular HTML color string.

getColorName

Converts color string into HTML color name string or return hex color string.

Returns: string - returns html color name or hex string.

Param Type Default Description
color string `` Regular HTML color string

getCrossingRectangles

Finds pairs of crossing rectangles.

Param Type Default Description
thisArg Object `` The callback function invocation context
rectangles Rect[] `` Collection of rectangles.
onCrossing onCrossingRectanglesItemCallback `` Callback function to pass pair of crossing rectangles.
Callbacks

onCrossingRectanglesItemCallback(rect1, rect2)

Callback function to iterate over pairs of crossing rectangles

Param Type Default Description
rect1 Rect `` First rectangle
rect2 Rect `` Second rectangle

getFamilyLoops

This function finds optimal collection of feedback edges needed to be cut in order to eliminate loops in family structure.

Returns: Edge[] - returns optimal collection of feedback loops

Param Type Default Description
family Family `` Family structure

getGreen

Gets green value of HEX color string.

Returns: number - returns green value of the hex color string.

Param Type Default Description
color string `` Color

getLiniarBreaks

Breaks collection of values into 3 intervals, so values stay close to each other within interval.

Returns: number[] - returns array containing 3 indexes. the first 2 break values into 3 intervals, the last index is actual index of the last element in the values collection.

Param Type Default Description
values number[] `` Array of values

getMergedIntervals

Merges collection of overlapping intervals into continuous group of intervals. Calls callback function to pass result interval per group of overlapping intervals.

Param Type Default Description
thisArg Object `` The callback function invocation context
items Interval[] `` Collection of intervals.
onItem onMergedIntervalItemCallback `` Callback function to pass result group of merged intervals.
Callbacks

onMergedIntervalItemCallback(interval, context)

Callback function to iterate over result intervals

Param Type Default Description
interval Interval `` Merged interval
context Object `` First interval context.

getMergedRectangles

Merges collection of rectangles into shapes. Calls callback function to pass result sequences of data points.

Param Type Default Description
thisArg Object `` The callback function invocation context
items Rect[] `` Collection of rectangles.
onItem onMergedRectangleItemCallback `` Callback function to pass result sequences of margin data points.
Callbacks

onMergedRectangleItemCallback(points)

Callback function to iterate over result shapes

Param Type Default Description
points Point[] `` Collection of points tracing margin around result area formed via merge of rectangles. The outer shape margin has clock wise sequence of data points. Internal holes inside of the shape are formed by counter clock wise sequence of data points.

getMinimumCrossingRows

Finds minimum number of horizontal lines crossing all rectangles

Param Type Default Description
thisArg Object `` The callback function invocation context
rectangles React[] `` Collection of rectangles
onItem onRowCallback `` Callback function to call for every found row
Callbacks

onRowCallback(row)

Callback for iterating rows

Param Type Default Description
row number `` The y coordinate of the horizontal line

getRed

Gets red value of HEX color string.

Returns: number - returns red value of the hex color string.

Param Type Default Description
color string `` Color

highestContrast

Finds contrast between base color and two optional first and second colors and returns the one which has highest contrast.

Returns: string - returns highest contrast color compared to base color.

Param Type Default Description
baseColor string `` Base color to compare with
firstColor string `` First color.
secondColor string `` Second color.

luminosity

Calculates luminosity between two HEX string colors.

Returns: number - returns luminosity value

Param Type Default Description
firstColor string `` First color.
secondColor string `` Second color.

mergeSort

Merges array of sorted arrays into one using call back function for comparison.

Returns: object[] - returns merged sorted array.

Param Type Default Description
arrays object[][] `` Array of sorted arrays of objects.
getItemWeight getItemWeightCallback `` Callback function to measure item weight.
ignoreDuplicates boolean `` If true returns distinct weight items only.
Callbacks

getItemWeightCallback(item)

Callback function to measure item weights of merged arrays.

Returns: number - returns item's weight.

Param Type Default Description
item object `` The item to weight