plmt-widgets-helper
v1.0.1
Published
Shared TypeScript helpers for PLMT widgets.
Downloads
170
Readme
plmt-widgets-helper
Общая TypeScript-библиотека с утилитами, которые переиспользуются в виджетах.
Установка
npm install plmt-widgets-helperИспользование
Библиотека экспортирует несколько пространств имён из одной точки входа:
Methods— функции и утилитыEnums— перечисленияTypes— типыInterfaces— интерфейсы
import { Methods } from "plmt-widgets-helper";
const bounds = Methods.getAxisMinMax({
min: "0",
max: "100",
dataMin: 12,
});
const formatted = Methods.format({ toFixed: 2, useGrouping: true }, 1234567.89);Типы и интерфейсы импортируются отдельно:
import type { Types, Interfaces } from "plmt-widgets-helper";
const value: Types.Nullable<string> = null;
const bounds: Interfaces.AxisMinMaxBounds = { min: 0, max: 100 };Основные группы методов
Конвертация значений
convertToCurrentType— приведение значения к типу колонкиconvertStringToCurrentType— парсинг строковых примитивов ('null','true', числа)checkValueIsNull— преобразование строки'null'вnull
Форматирование
format— форматирование чисел по настройкамformatNullableValue— форматирование с обработкойnull/undefinedgetOneAxisFormatter— выбор форматтера для общей осиtruncate— обрезка строки
Оси графиков
toAxisBoundNumber— парсинг границ оси из пользовательского вводаgetAxisMinMax— сборкаmin/maxдля опций EChartsgetFiniteNumericMin— минимум среди конечных чиселgetLogAxisMinFromExtent— нижняя граница логарифмической оси
Прочее
measureTextWidth,textLengthAtAngle— расчёт размеров текстаsetTextProperties,setElementsColorProperty— стили из темыMethods.Lodash— реэкспорт часто используемых функций lodash
Разработка
npm install
npm run typecheck
npm run buildНовый код добавляйте в соответствующую папку внутри src, экспортируйте из её index.ts — после этого он станет доступен из корневого импорта библиотеки.
Сборка попадает в dist и именно она публикуется в npm.
