12604159536

Committed 03 Jan 2025 09:26PM UTC coverage: 66.843% (-0.5%) from 67.344%

Build # 12604159536

Build Type

Pull #2892

github

Committed by

web-flow

Commit Message

Merge 894aa31a5 into 0b67c5409

Pull Request Pull Request #2892: [fix] Prevent infinite useEffects loop

Run Details

5959 of 10355 branches covered (57.55%)

Branch coverage included in aggregate %.

13 of 16 new or added lines in 1 file covered. (81.25%)

484 existing lines in 25 files now uncovered.

12215 of 16834 relevant lines covered (72.56%)

89.16 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.16

/src/utils/src/data-utils.ts

// SPDX-License-Identifier: MIT
// Copyright contributors to the kepler.gl project

import assert from 'assert';
import {format as d3Format} from 'd3-format';
import moment from 'moment-timezone';

import {
  ALL_FIELD_TYPES,
  TOOLTIP_FORMATS,
  TOOLTIP_FORMAT_TYPES,
  TOOLTIP_KEY,
  TooltipFormat
} from '@kepler.gl/constants';
import {notNullorUndefined} from '@kepler.gl/common-utils';
import {Field, Millisecond} from '@kepler.gl/types';

import {snapToMarks} from './plot';
import {isPlainObject} from './utils';

export type FieldFormatter = (value: any) => string;

// We need threat latitude differently otherwise marcator project view throws
// a projection matrix error
// Uncaught Error: Pixel project matrix not invertible
// at WebMercatorViewport16.Viewport6 (viewport.js:81:13)
export const MAX_LATITUDE = 89.9;
export const MIN_LATITUDE = -89.9;
export const MAX_LONGITUDE = 180;
export const MIN_LONGITUDE = -180;

/**
 * Validates a latitude value.
 * Ensures that the latitude is within the defined minimum and maximum latitude bounds.
 * If the value is out of bounds, it returns the nearest bound value.
 * @param latitude - The latitude value to validate.
 * @returns The validated latitude value.
 */
export function validateLatitude(latitude: number | undefined): number {
  return validateCoordinate(latitude ?? 0, MIN_LATITUDE, MAX_LATITUDE);
}

/**
 * Validates a longitude value.
 * Ensures that the longitude is within the defined minimum and maximum longitude bounds.
 * If the value is out of bounds, it returns the nearest bound value.
 * @param longitude - The longitude value to validate.
 * @returns The validated longitude value.
 */
export function validateLongitude(longitude: number | undefined): number {
  return validateCoordinate(longitude ?? 0, MIN_LONGITUDE, MAX_LONGITUDE);
}

/**
 * Validates a coordinate value.
 * Ensures that the value is within the specified minimum and maximum bounds.
 * If the value is out of bounds, it returns the nearest bound value.
 * @param value - The coordinate value to validate.
 * @param minValue - The minimum bound for the value.
 * @param maxValue - The maximum bound for the value.
 * @returns The validated coordinate value.
 */
export function validateCoordinate(value: number, minValue: number, maxValue: number): number {
  if (value <= minValue) {
    return minValue;
  }
  if (value >= maxValue) {
    return maxValue;
  }

  return value;
}

/**
 * simple getting unique values of an array
 *
 * @param values
 * @returns unique values
 */
export function unique<T>(values: T[]) {
  const results: T[] = [];
  const uniqueSet = new Set(values);
  uniqueSet.forEach(v => {
    if (notNullorUndefined(v)) {
      results.push(v);
    }
  });
  return results;
}

export function getLatLngBounds(
  points: number[][],
  idx: number,
  limit: [number, number]
): [number, number] | null {
  const lats = points
    .map(d => Number(Array.isArray(d)) && d[idx])
    .filter(Number.isFinite)
    .sort(numberSort);

  if (!lats.length) {
    return null;
  }

  // clamp to limit
  return [Math.max(lats[0], limit[0]), Math.min(lats[lats.length - 1], limit[1])];
}

export function clamp([min, max]: [number, number], val = 0): number {
  return val <= min ? min : val >= max ? max : val;
}

export function getSampleData(data, sampleSize = 500, getValue = d => d) {
  const sampleStep = Math.max(Math.floor(data.length / sampleSize), 1);
  const output: any[] = [];
  for (let i = 0; i < data.length; i += sampleStep) {
    output.push(getValue(data[i]));
  }

  return output;
}

/**
 * Convert different time format to unix milliseconds
 */
export function timeToUnixMilli(value: string | number | Date, format: string): Millisecond | null {
  if (notNullorUndefined(value)) {
    if (typeof value === 'string') {
      return moment.utc(value, format).valueOf();
    }
    if (typeof value === 'number') {
      return format === 'x' ? value * 1000 : value;
    }
    if (value instanceof Date) {
      return value.valueOf();
    }
  }
  return null;
}

/**
 * Whether d is a number, this filtered out NaN as well
 */
export function isNumber(d: unknown): d is number {
  return Number.isFinite(d);
}

/**
 * whether object has property
 * @param {string} prop
 * @returns {boolean} - yes or no
 */
export function hasOwnProperty<X extends object, Y extends PropertyKey>(
  obj: X,
  prop: Y
): obj is X & Record<Y, unknown> {
  return Object.prototype.hasOwnProperty.call(obj, prop);
}

export function numberSort(a: number, b: number): number {
  return a - b;
}

export function getSortingFunction(fieldType: string): typeof numberSort | undefined {
  switch (fieldType) {
    case ALL_FIELD_TYPES.real:
    case ALL_FIELD_TYPES.integer:
    case ALL_FIELD_TYPES.timestamp:
      return numberSort;
    default:
      return undefined;
  }
}

/**
 * round number with exact number of decimals
 * return as a string
 */
export function preciseRound(num: number, decimals: number): string {
  const t = Math.pow(10, decimals);
  return (
    Math.round(
      num * t + (decimals > 0 ? 1 : 0) * (Math.sign(num) * (10 / Math.pow(100, decimals)))
    ) / t
  ).toFixed(decimals);
}

/**
 * round a giving number at most 4 decimal places
 * e.g. 10 -> 10, 1.12345 -> 1.2345, 2.0 -> 2
 */
export function roundToFour(num: number): number {
  // @ts-expect-error
  return Number(`${Math.round(`${num}e+4`)}e-4`);
}
/**
 * get number of decimals to round to for slider from step
 * @param step
 * @returns- number of decimal
 */
export function getRoundingDecimalFromStep(step: number): number {
  if (isNaN(step)) {
    assert('step is not a number');
    assert(step);
  }

  const stepStr = step.toString();

  // in case the step is a very small number e.g. 1e-7, return decimal e.g. 7 directly
  const splitExponential = stepStr.split('e-');
  if (splitExponential.length === 2) {
    const coeffZero = splitExponential[0].split('.');
    const coeffDecimal = coeffZero.length === 1 ? 0 : coeffZero[1].length;
    return parseInt(splitExponential[1], 10) + coeffDecimal;
  }

  const splitZero = stepStr.split('.');
  if (splitZero.length === 1) {
    return 0;
  }
  return splitZero[1].length;
}

/**
 * If marks is provided, snap to marks, if not normalize to step
 * @param val
 * @param minValue
 * @param step
 * @param marks
 */
export function normalizeSliderValue(
  val: number,
  minValue: number | undefined,
  step: number,
  marks?: number[] | null
): number {
  if (marks && marks.length) {
    // Use in slider, given a number and an array of numbers, return the nears number from the array
    return snapToMarks(val, marks);
  }

  return roundValToStep(minValue, step, val);
}

/**
 * round the value to step for the slider
 * @param minValue
 * @param step
 * @param val
 * @returns - rounded number
 */
export function roundValToStep(minValue: number | undefined, step: number, val: number): number {
  if (!isNumber(step) || !isNumber(minValue)) {
    return val;
  }

  const decimal = getRoundingDecimalFromStep(step);
  const steps = Math.floor((val - minValue) / step);
  let remain = val - (steps * step + minValue);

  // has to round because javascript turns 0.1 into 0.9999999999999987
  remain = Number(preciseRound(remain, 8));

  let closest: number;
  if (remain === 0) {
    closest = val;
  } else if (remain < step / 2) {
    closest = steps * step + minValue;
  } else {
    closest = (steps + 1) * step + minValue;
  }

  // precise round return a string rounded to the defined decimal
  const rounded = preciseRound(closest, decimal);

  return Number(rounded);
}

/**
 * Get the value format based on field and format options
 * Used in render tooltip value
 */
export const defaultFormatter: FieldFormatter = v => (notNullorUndefined(v) ? String(v) : '');

export const floatFormatter = v => (isNumber(v) ? String(roundToFour(v)) : '');

export const FIELD_DISPLAY_FORMAT: {
  [key: string]: FieldFormatter;
} = {
  [ALL_FIELD_TYPES.string]: defaultFormatter,
  [ALL_FIELD_TYPES.timestamp]: defaultFormatter,
  [ALL_FIELD_TYPES.integer]: defaultFormatter,
  [ALL_FIELD_TYPES.real]: defaultFormatter,
  [ALL_FIELD_TYPES.boolean]: defaultFormatter,
  [ALL_FIELD_TYPES.date]: defaultFormatter,
  [ALL_FIELD_TYPES.geojson]: d =>
    typeof d === 'string'
      ? d
      : isPlainObject(d)
      ? JSON.stringify(d)
      : Array.isArray(d)
      ? `[${String(d)}]`
      : '',
  [ALL_FIELD_TYPES.geoarrow]: d => d,
  [ALL_FIELD_TYPES.object]: JSON.stringify,
  [ALL_FIELD_TYPES.array]: JSON.stringify,
  [ALL_FIELD_TYPES.h3]: defaultFormatter
};

/**
 * Parse field value and type and return a string representation
 */
export const parseFieldValue = (value: any, type: string): string => {
  if (!notNullorUndefined(value)) {
    return '';
  }
  return FIELD_DISPLAY_FORMAT[type] ? FIELD_DISPLAY_FORMAT[type](value) : String(value);
};

/**
 * Get the value format based on field and format options
 * Used in render tooltip value
 * @param format
 * @param field
 */
export function getFormatter(
  format?: string | Record<string, string> | null,
  field?: Field
): FieldFormatter {
  if (!format) {
    return defaultFormatter;
  }
  const tooltipFormat = Object.values(TOOLTIP_FORMATS).find(f => f[TOOLTIP_KEY] === format);

  if (tooltipFormat) {
    return applyDefaultFormat(tooltipFormat as TooltipFormat);
  } else if (typeof format === 'string' && field) {
    return applyCustomFormat(format, field);
  }

  return defaultFormatter;
}

export function getColumnFormatter(
  field: Pick<Field, 'type'> & Partial<Pick<Field, 'format' | 'displayFormat'>>
): FieldFormatter {
  const {format, displayFormat} = field;

  if (!format && !displayFormat) {
    return FIELD_DISPLAY_FORMAT[field.type];
  }
  const tooltipFormat = Object.values(TOOLTIP_FORMATS).find(f => f[TOOLTIP_KEY] === displayFormat);

  if (tooltipFormat) {
    return applyDefaultFormat(tooltipFormat);
  } else if (typeof displayFormat === 'string' && field) {
    return applyCustomFormat(displayFormat, field);
  } else if (typeof displayFormat === 'object') {
    return applyValueMap(displayFormat);
  }

  return defaultFormatter;
}

export function applyValueMap(format) {
  return v => format[v];
}

export function applyDefaultFormat(tooltipFormat: TooltipFormat): (v: any) => string {
  if (!tooltipFormat || !tooltipFormat.format) {
    return defaultFormatter;
  }

  switch (tooltipFormat.type) {
    case TOOLTIP_FORMAT_TYPES.DECIMAL:
      return d3Format(tooltipFormat.format);
    case TOOLTIP_FORMAT_TYPES.DATE:
    case TOOLTIP_FORMAT_TYPES.DATE_TIME:
      return datetimeFormatter(null)(tooltipFormat.format);
    case TOOLTIP_FORMAT_TYPES.PERCENTAGE:
      return v => `${d3Format(TOOLTIP_FORMATS.DECIMAL_DECIMAL_FIXED_2.format)(v)}%`;
    case TOOLTIP_FORMAT_TYPES.BOOLEAN:
      return getBooleanFormatter(tooltipFormat.format);
    default:
      return defaultFormatter;
  }
}

export function getBooleanFormatter(format: string): FieldFormatter {
  switch (format) {
    case '01':
      return (v: boolean) => (v ? '1' : '0');
    case 'yn':
      return (v: boolean) => (v ? 'yes' : 'no');
    default:
      return defaultFormatter;
  }
}
// Allow user to specify custom tooltip format via config
export function applyCustomFormat(format, field: {type?: string}): FieldFormatter {
  switch (field.type) {
    case ALL_FIELD_TYPES.real:
    case ALL_FIELD_TYPES.integer:
      return d3Format(format);
    case ALL_FIELD_TYPES.date:
    case ALL_FIELD_TYPES.timestamp:
      return datetimeFormatter(null)(format);
    default:
      return v => v;
  }
}

function formatLargeNumber(n) {
  // SI-prefix with 4 significant digits
  return d3Format('.4~s')(n);
}

export function formatNumber(n: number, type?: string): string {
  switch (type) {
    case ALL_FIELD_TYPES.integer:
      if (n < 0) {
        return `-${formatNumber(-n, 'integer')}`;
      }
      if (n < 1000) {
        return `${Math.round(n)}`;
      }
      if (n < 10 * 1000) {
        return d3Format(',')(Math.round(n));
      }
      return formatLargeNumber(n);
    case ALL_FIELD_TYPES.real:
      if (n < 0) {
        return `-${formatNumber(-n, 'number')}`;
      }
      if (n < 1000) {
        return d3Format('.4~r')(n);
      }
      if (n < 10 * 1000) {
        return d3Format(',.2~f')(n);
      }
      return formatLargeNumber(n);

    default:
      return formatNumber(n, 'real');
  }
}

const transformation = {
  Y: Math.pow(10, 24),
  Z: Math.pow(10, 21),
  E: Math.pow(10, 18),
  P: Math.pow(10, 15),
  T: Math.pow(10, 12),
  G: Math.pow(10, 9),
  M: Math.pow(10, 6),
  k: Math.pow(10, 3),
  h: Math.pow(10, 2),
  da: Math.pow(10, 1),
  d: Math.pow(10, -1),
  c: Math.pow(10, -2),
  m: Math.pow(10, -3),
  μ: Math.pow(10, -6),
  n: Math.pow(10, -9),
  p: Math.pow(10, -12),
  f: Math.pow(10, -15),
  a: Math.pow(10, -18),
  z: Math.pow(10, -21),
  y: Math.pow(10, -24)
};

/**
 * Convert a formatted number from string back to number
 */
export function reverseFormatNumber(str: string): number {
  let returnValue: number | null = null;
  const strNum = str.trim().replace(/,/g, '');
  Object.entries(transformation).forEach(d => {
    if (strNum.includes(d[0])) {
      returnValue = parseFloat(strNum) * d[1];
      return true;
    }
    return false;
  });

  // if no transformer found, convert to nuber regardless
  return returnValue === null ? Number(strNum) : returnValue;
}

/**
 * Format epoch milliseconds with a format string
 * @type timezone
 */
export function datetimeFormatter(
  timezone?: string | null
): (format?: string) => (ts: number) => string {
  return timezone
    ? format => ts => moment.utc(ts).tz(timezone).format(format)
    : // return empty string instead of 'Invalid date' if ts is undefined/null
      format => ts => ts ? moment.utc(ts).format(format) : '';
}

1	// SPDX-License-Identifier: MIT
2	// Copyright contributors to the kepler.gl project
3
4	import assert from 'assert';
5	import {format as d3Format} from 'd3-format';
6	import moment from 'moment-timezone';
7
8	import {
9	ALL_FIELD_TYPES,
10	TOOLTIP_FORMATS,
11	TOOLTIP_FORMAT_TYPES,
12	TOOLTIP_KEY,
13	TooltipFormat
14	} from '@kepler.gl/constants';
15	import {notNullorUndefined} from '@kepler.gl/common-utils';
16	import {Field, Millisecond} from '@kepler.gl/types';
17
18	import {snapToMarks} from './plot';
19	import {isPlainObject} from './utils';
20
21	export type FieldFormatter = (value: any) => string;
22
23	// We need threat latitude differently otherwise marcator project view throws
24	// a projection matrix error
25	// Uncaught Error: Pixel project matrix not invertible
26	// at WebMercatorViewport16.Viewport6 (viewport.js:81:13)
27	export const MAX_LATITUDE = 89.9;	15✔
28	export const MIN_LATITUDE = -89.9;	15✔
29	export const MAX_LONGITUDE = 180;	15✔
30	export const MIN_LONGITUDE = -180;	15✔
31
32	/**
33	* Validates a latitude value.
34	* Ensures that the latitude is within the defined minimum and maximum latitude bounds.
35	* If the value is out of bounds, it returns the nearest bound value.
36	* @param latitude - The latitude value to validate.
37	* @returns The validated latitude value.
38	*/
39	export function validateLatitude(latitude: number \| undefined): number {
40	return validateCoordinate(latitude ?? 0, MIN_LATITUDE, MAX_LATITUDE);	260!
41	}
42
43	/**
44	* Validates a longitude value.
45	* Ensures that the longitude is within the defined minimum and maximum longitude bounds.
46	* If the value is out of bounds, it returns the nearest bound value.
47	* @param longitude - The longitude value to validate.
48	* @returns The validated longitude value.
49	*/
50	export function validateLongitude(longitude: number \| undefined): number {
51	return validateCoordinate(longitude ?? 0, MIN_LONGITUDE, MAX_LONGITUDE);	260!
52	}
53
54	/**
55	* Validates a coordinate value.
56	* Ensures that the value is within the specified minimum and maximum bounds.
57	* If the value is out of bounds, it returns the nearest bound value.
58	* @param value - The coordinate value to validate.
59	* @param minValue - The minimum bound for the value.
60	* @param maxValue - The maximum bound for the value.
61	* @returns The validated coordinate value.
62	*/
63	export function validateCoordinate(value: number, minValue: number, maxValue: number): number {
64	if (value <= minValue) {	520✔
65	return minValue;	7✔
66	}
67	if (value >= maxValue) {	513!
UNCOV 68	return maxValue;	×
69	}
70
71	return value;	513✔
72	}
73
74	/**
75	* simple getting unique values of an array
76	*
77	* @param values
78	* @returns unique values
79	*/
80	export function unique<T>(values: T[]) {
81	const results: T[] = [];	57✔
82	const uniqueSet = new Set(values);	57✔
83	uniqueSet.forEach(v => {	57✔
84	if (notNullorUndefined(v)) {	210✔
85	results.push(v);	182✔
86	}
87	});
88	return results;	57✔
89	}
90
91	export function getLatLngBounds(
92	points: number[][],
93	idx: number,
94	limit: [number, number]
95	): [number, number] \| null {
96	const lats = points	666✔
97	.map(d => Number(Array.isArray(d)) && d[idx])	6,756✔
98	.filter(Number.isFinite)
99	.sort(numberSort);
100
101	if (!lats.length) {	666!
UNCOV 102	return null;	×
103	}
104
105	// clamp to limit
106	return [Math.max(lats[0], limit[0]), Math.min(lats[lats.length - 1], limit[1])];	666✔
107	}
108
109	export function clamp([min, max]: [number, number], val = 0): number {	×
110	return val <= min ? min : val >= max ? max : val;	25✔
111	}
112
UNCOV 113	export function getSampleData(data, sampleSize = 500, getValue = d => d) {	×
UNCOV 114	const sampleStep = Math.max(Math.floor(data.length / sampleSize), 1);	×
UNCOV 115	const output: any[] = [];	×
UNCOV 116	for (let i = 0; i < data.length; i += sampleStep) {	×
UNCOV 117	output.push(getValue(data[i]));	×
118	}
119
UNCOV 120	return output;	×
121	}
122
123	/**
124	* Convert different time format to unix milliseconds
125	*/
126	export function timeToUnixMilli(value: string \| number \| Date, format: string): Millisecond \| null {
127	if (notNullorUndefined(value)) {	2,342✔
128	if (typeof value === 'string') {	2,289✔
129	return moment.utc(value, format).valueOf();	648✔
130	}
131	if (typeof value === 'number') {	1,641!
132	return format === 'x' ? value * 1000 : value;	1,641✔
133	}
UNCOV 134	if (value instanceof Date) {	×
UNCOV 135	return value.valueOf();	×
136	}
137	}
138	return null;	53✔
139	}
140
141	/**
142	* Whether d is a number, this filtered out NaN as well
143	*/
144	export function isNumber(d: unknown): d is number {
145	return Number.isFinite(d);	805✔
146	}
147
148	/**
149	* whether object has property
150	* @param {string} prop
151	* @returns {boolean} - yes or no
152	*/
153	export function hasOwnProperty<X extends object, Y extends PropertyKey>(
154	obj: X,
155	prop: Y
156	): obj is X & Record<Y, unknown> {
157	return Object.prototype.hasOwnProperty.call(obj, prop);	9✔
158	}
159
160	export function numberSort(a: number, b: number): number {
161	return a - b;	17,076✔
162	}
163
164	export function getSortingFunction(fieldType: string): typeof numberSort \| undefined {
165	switch (fieldType) {	131✔
166	case ALL_FIELD_TYPES.real:
167	case ALL_FIELD_TYPES.integer:
168	case ALL_FIELD_TYPES.timestamp:
169	return numberSort;	96✔
170	default:
171	return undefined;	35✔
172	}
173	}
174
175	/**
176	* round number with exact number of decimals
177	* return as a string
178	*/
179	export function preciseRound(num: number, decimals: number): string {
180	const t = Math.pow(10, decimals);	82✔
181	return (	82✔
182	Math.round(
183	num * t + (decimals > 0 ? 1 : 0) * (Math.sign(num) * (10 / Math.pow(100, decimals)))	82✔
184	) / t
185	).toFixed(decimals);
186	}
187
188	/**
189	* round a giving number at most 4 decimal places
190	* e.g. 10 -> 10, 1.12345 -> 1.2345, 2.0 -> 2
191	*/
192	export function roundToFour(num: number): number {
193	// @ts-expect-error
194	return Number(`${Math.round(`${num}e+4`)}e-4`);	5✔
195	}
196	/**
197	* get number of decimals to round to for slider from step
198	* @param step
199	* @returns- number of decimal
200	*/
201	export function getRoundingDecimalFromStep(step: number): number {
202	if (isNaN(step)) {	30!
UNCOV 203	assert('step is not a number');	×
UNCOV 204	assert(step);	×
205	}
206
207	const stepStr = step.toString();	30✔
208
209	// in case the step is a very small number e.g. 1e-7, return decimal e.g. 7 directly
210	const splitExponential = stepStr.split('e-');	30✔
211	if (splitExponential.length === 2) {	30✔
212	const coeffZero = splitExponential[0].split('.');	2✔
213	const coeffDecimal = coeffZero.length === 1 ? 0 : coeffZero[1].length;	2✔
214	return parseInt(splitExponential[1], 10) + coeffDecimal;	2✔
215	}
216
217	const splitZero = stepStr.split('.');	28✔
218	if (splitZero.length === 1) {	28✔
219	return 0;	9✔
220	}
221	return splitZero[1].length;	19✔
222	}
223
224	/**
225	* If marks is provided, snap to marks, if not normalize to step
226	* @param val
227	* @param minValue
228	* @param step
229	* @param marks
230	*/
231	export function normalizeSliderValue(
232	val: number,
233	minValue: number \| undefined,
234	step: number,
235	marks?: number[] \| null
236	): number {
237	if (marks && marks.length) {	8✔
238	// Use in slider, given a number and an array of numbers, return the nears number from the array
239	return snapToMarks(val, marks);	1✔
240	}
241
242	return roundValToStep(minValue, step, val);	7✔
243	}
244
245	/**
246	* round the value to step for the slider
247	* @param minValue
248	* @param step
249	* @param val
250	* @returns - rounded number
251	*/
252	export function roundValToStep(minValue: number \| undefined, step: number, val: number): number {
253	if (!isNumber(step) \|\| !isNumber(minValue)) {	22✔
254	return val;	2✔
255	}
256
257	const decimal = getRoundingDecimalFromStep(step);	20✔
258	const steps = Math.floor((val - minValue) / step);	20✔
259	let remain = val - (steps * step + minValue);	20✔
260
261	// has to round because javascript turns 0.1 into 0.9999999999999987
262	remain = Number(preciseRound(remain, 8));	20✔
263
264	let closest: number;
265	if (remain === 0) {	20✔
266	closest = val;	5✔
267	} else if (remain < step / 2) {	15✔
268	closest = steps * step + minValue;	4✔
269	} else {
270	closest = (steps + 1) * step + minValue;	11✔
271	}
272
273	// precise round return a string rounded to the defined decimal
274	const rounded = preciseRound(closest, decimal);	20✔
275
276	return Number(rounded);	20✔
277	}
278
279	/**
280	* Get the value format based on field and format options
281	* Used in render tooltip value
282	*/
283	export const defaultFormatter: FieldFormatter = v => (notNullorUndefined(v) ? String(v) : '');	1,716✔
284
285	export const floatFormatter = v => (isNumber(v) ? String(roundToFour(v)) : '');	15!
286
287	export const FIELD_DISPLAY_FORMAT: {
288	[key: string]: FieldFormatter;
289	} = {	15✔
290	[ALL_FIELD_TYPES.string]: defaultFormatter,
291	[ALL_FIELD_TYPES.timestamp]: defaultFormatter,
292	[ALL_FIELD_TYPES.integer]: defaultFormatter,
293	[ALL_FIELD_TYPES.real]: defaultFormatter,
294	[ALL_FIELD_TYPES.boolean]: defaultFormatter,
295	[ALL_FIELD_TYPES.date]: defaultFormatter,
296	[ALL_FIELD_TYPES.geojson]: d =>
297	typeof d === 'string'	23✔
298	? d
299	: isPlainObject(d)	20!
300	? JSON.stringify(d)
301	: Array.isArray(d)	×
302	? `[${String(d)}]`
303	: '',
UNCOV 304	[ALL_FIELD_TYPES.geoarrow]: d => d,	×
305	[ALL_FIELD_TYPES.object]: JSON.stringify,
306	[ALL_FIELD_TYPES.array]: JSON.stringify,
307	[ALL_FIELD_TYPES.h3]: defaultFormatter
308	};
309
310	/**
311	* Parse field value and type and return a string representation
312	*/
313	export const parseFieldValue = (value: any, type: string): string => {	15✔
314	if (!notNullorUndefined(value)) {	665✔
315	return '';	104✔
316	}
317	return FIELD_DISPLAY_FORMAT[type] ? FIELD_DISPLAY_FORMAT[type](value) : String(value);	561!
318	};
319
320	/**
321	* Get the value format based on field and format options
322	* Used in render tooltip value
323	* @param format
324	* @param field
325	*/
326	export function getFormatter(
327	format?: string \| Record<string, string> \| null,
328	field?: Field
329	): FieldFormatter {
330	if (!format) {	473✔
331	return defaultFormatter;	1✔
332	}
333	const tooltipFormat = Object.values(TOOLTIP_FORMATS).find(f => f[TOOLTIP_KEY] === format);	11,470✔
334
335	if (tooltipFormat) {	472✔
336	return applyDefaultFormat(tooltipFormat as TooltipFormat);	465✔
337	} else if (typeof format === 'string' && field) {	7✔
338	return applyCustomFormat(format, field);	6✔
339	}
340
341	return defaultFormatter;	1✔
342	}
343
344	export function getColumnFormatter(
345	field: Pick<Field, 'type'> & Partial<Pick<Field, 'format' \| 'displayFormat'>>
346	): FieldFormatter {
347	const {format, displayFormat} = field;	1,566✔
348
349	if (!format && !displayFormat) {	1,566✔
350	return FIELD_DISPLAY_FORMAT[field.type];	621✔
351	}
352	const tooltipFormat = Object.values(TOOLTIP_FORMATS).find(f => f[TOOLTIP_KEY] === displayFormat);	27,540✔
353
354	if (tooltipFormat) {	945✔
355	return applyDefaultFormat(tooltipFormat);	81✔
356	} else if (typeof displayFormat === 'string' && field) {	864!
UNCOV 357	return applyCustomFormat(displayFormat, field);	×
358	} else if (typeof displayFormat === 'object') {	864!
UNCOV 359	return applyValueMap(displayFormat);	×
360	}
361
362	return defaultFormatter;	864✔
363	}
364
365	export function applyValueMap(format) {
UNCOV 366	return v => format[v];	×
367	}
368
369	export function applyDefaultFormat(tooltipFormat: TooltipFormat): (v: any) => string {
370	if (!tooltipFormat \|\| !tooltipFormat.format) {	546!
UNCOV 371	return defaultFormatter;	×
372	}
373
374	switch (tooltipFormat.type) {	546!
375	case TOOLTIP_FORMAT_TYPES.DECIMAL:
376	return d3Format(tooltipFormat.format);	83✔
377	case TOOLTIP_FORMAT_TYPES.DATE:
378	case TOOLTIP_FORMAT_TYPES.DATE_TIME:
379	return datetimeFormatter(null)(tooltipFormat.format);	458✔
380	case TOOLTIP_FORMAT_TYPES.PERCENTAGE:
381	return v => `${d3Format(TOOLTIP_FORMATS.DECIMAL_DECIMAL_FIXED_2.format)(v)}%`;	1✔
382	case TOOLTIP_FORMAT_TYPES.BOOLEAN:
383	return getBooleanFormatter(tooltipFormat.format);	4✔
384	default:
UNCOV 385	return defaultFormatter;	×
386	}
387	}
388
389	export function getBooleanFormatter(format: string): FieldFormatter {
390	switch (format) {	4!
391	case '01':
392	return (v: boolean) => (v ? '1' : '0');	2✔
393	case 'yn':
394	return (v: boolean) => (v ? 'yes' : 'no');	2✔
395	default:
UNCOV 396	return defaultFormatter;	×
397	}
398	}
399	// Allow user to specify custom tooltip format via config
400	export function applyCustomFormat(format, field: {type?: string}): FieldFormatter {
401	switch (field.type) {	6!
402	case ALL_FIELD_TYPES.real:
403	case ALL_FIELD_TYPES.integer:
404	return d3Format(format);	5✔
405	case ALL_FIELD_TYPES.date:
406	case ALL_FIELD_TYPES.timestamp:
407	return datetimeFormatter(null)(format);	1✔
408	default:
UNCOV 409	return v => v;	×
410	}
411	}
412
413	function formatLargeNumber(n) {
414	// SI-prefix with 4 significant digits
415	return d3Format('.4~s')(n);	24✔
416	}
417
418	export function formatNumber(n: number, type?: string): string {
419	switch (type) {	217✔
420	case ALL_FIELD_TYPES.integer:
421	if (n < 0) {	137✔
422	return `-${formatNumber(-n, 'integer')}`;	1✔
423	}
424	if (n < 1000) {	136✔
425	return `${Math.round(n)}`;	36✔
426	}
427	if (n < 10 * 1000) {	100✔
428	return d3Format(',')(Math.round(n));	77✔
429	}
430	return formatLargeNumber(n);	23✔
431	case ALL_FIELD_TYPES.real:
432	if (n < 0) {	77!
UNCOV 433	return `-${formatNumber(-n, 'number')}`;	×
434	}
435	if (n < 1000) {	77✔
436	return d3Format('.4~r')(n);	52✔
437	}
438	if (n < 10 * 1000) {	25✔
439	return d3Format(',.2~f')(n);	24✔
440	}
441	return formatLargeNumber(n);	1✔
442
443	default:
444	return formatNumber(n, 'real');	3✔
445	}
446	}
447
448	const transformation = {	15✔
449	Y: Math.pow(10, 24),
450	Z: Math.pow(10, 21),
451	E: Math.pow(10, 18),
452	P: Math.pow(10, 15),
453	T: Math.pow(10, 12),
454	G: Math.pow(10, 9),
455	M: Math.pow(10, 6),
456	k: Math.pow(10, 3),
457	h: Math.pow(10, 2),
458	da: Math.pow(10, 1),
459	d: Math.pow(10, -1),
460	c: Math.pow(10, -2),
461	m: Math.pow(10, -3),
462	μ: Math.pow(10, -6),
463	n: Math.pow(10, -9),
464	p: Math.pow(10, -12),
465	f: Math.pow(10, -15),
466	a: Math.pow(10, -18),
467	z: Math.pow(10, -21),
468	y: Math.pow(10, -24)
469	};
470
471	/**
472	* Convert a formatted number from string back to number
473	*/
474	export function reverseFormatNumber(str: string): number {
475	let returnValue: number \| null = null;	110✔
476	const strNum = str.trim().replace(/,/g, '');	110✔
477	Object.entries(transformation).forEach(d => {	110✔
478	if (strNum.includes(d[0])) {	2,200✔
479	returnValue = parseFloat(strNum) * d[1];	21✔
480	return true;	21✔
481	}
482	return false;	2,179✔
483	});
484
485	// if no transformer found, convert to nuber regardless
486	return returnValue === null ? Number(strNum) : returnValue;	110✔
487	}
488
489	/**
490	* Format epoch milliseconds with a format string
491	* @type timezone
492	*/
493	export function datetimeFormatter(
494	timezone?: string \| null
495	): (format?: string) => (ts: number) => string {
496	return timezone	480✔
497	? format => ts => moment.utc(ts).tz(timezone).format(format)	18✔
498	: // return empty string instead of 'Invalid date' if ts is undefined/null
499	format => ts => ts ? moment.utc(ts).format(format) : '';	493✔
500	}

keplergl / kepler.gl / 12604159536

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous