Utility Functions

LyteNyte Grid exports a small number of utility functions that can be used to enhance the grid's capabilities or within your own application.

measureText

The measureText function estimates the width, in pixels, of a string. It uses an offscreen canvas to compute the result.

1
function measureText(text: string, reference?: HTMLElement | string | undefined | null): TextMetrics;
2

3
// Example usage.
4
measureText("Check my length.");
5

6
// Use the body element’s font settings.
7
measureText("Check my length.", document.body);

moveRelative

The moveRelative function reorders items in an array. This function is most useful for drag-and-drop operations.

1
function moveRelative<T>(items: T[], srcIndex: number, destIndex: number, additional: number[] = []): T[];
2

3
// Example usage
4
moveRelative([1, 2, 3, 4, 5], 3, 1, []);

equal

The equal function performs fast deep equality comparisons. This function is a customized fork of React Fast Compare.

1
export function equal(a: any, b: any, compareFunctionsAsStrings: boolean = false);
2

3
// Example usage
4
equal({ x: 132 }, { y: 11, x: 23 });

arrayShallow

The arrayShallow function compares two arrays for shallow equality. This comparison is faster when you only care about reference equality within the array.

1
export function arrayShallow(left: any[], right: any[]): boolean;
2

3
// Example usage
4
arrayShallow([2, { x: 122 }], [2, { x: 11 }]);

virtualFromXY

The virtualFromXY function returns a virtual anchor that can be used with the popover component provided by LyteNyte Grid.

1
function virtualFromXY(x: number, y: number, context?: HTMLElement): VirtualTarget;
2

3
// Example usage
4
virtualFromXY(132, 33);