Публичные методы

Библиотека предоставляет набор публичных методов экземпляра, предназначенных для управления значением, форматированием и состоянием привязанного input-элемента. Эти методы образуют основной API взаимодействия с уже инициализированным объектом AutoNumeric и позволяют изменять данные без прямого обращения к DOM-значению.

set(value)

Метод set выполняет установку нового значения с автоматическим применением правил форматирования, заданных конфигурацией экземпляра.

Сигнатура:

autoNumericInstance.set(value);

Особенности поведения:

  • Принимает числовые значения, строки и частично форматированные строки
  • Перезапускает процесс форматирования согласно текущим настройкам
  • Обновляет внутреннее состояние экземпляра
  • Синхронизирует DOM-элемент

Пример использования:

autoNumericInstance.set(12345.67);
autoNumericInstance.set("12 345,67");
autoNumericInstance.set(null);

При передаче некорректных значений поведение зависит от настроек строгой валидации: возможна очистка поля или игнорирование изменения.

getNumber()

Метод getNumber возвращает числовое значение в виде JavaScript Number.

Сигнатура:

autoNumericInstance.getNumber();

Характеристики:

  • Возвращает Number или null, если значение отсутствует
  • Игнорирует визуальное форматирование (разделители, символы валют)
  • Может возвращать округлённый результат при высокой точности настроек

Пример:

const value = autoNumericInstance.getNumber();

Используется в вычислениях, где требуется чистое числовое представление без форматирования.

getNumericString()

Метод getNumericString возвращает строковое представление числа в «чистом» виде, без группировок и символов оформления.

Сигнатура:

autoNumericInstance.getNumericString();

Особенности:

  • Возвращает строку, а не число
  • Сохраняет точность, недоступную типу Number
  • Подходит для финансовых и высокоточных вычислений

Пример:

const raw = autoNumericInstance.getNumericString(); // "12345.67"

getFormatted()

Метод getFormatted возвращает текущее значение в отображаемом формате, включая разделители, символы валют и локализацию.

Сигнатура:

autoNumericInstance.getFormatted();

Поведение:

  • Возвращает строку, идентичную тому, что отображается в input
  • Учитывает все правила форматирования текущего экземпляра

Пример:

const formatted = autoNumericInstance.getFormatted(); // "12 345,67 €"

clear()

Метод clear очищает значение поля, устанавливая его в пустое состояние с учётом настроек библиотеки.

Сигнатура:

autoNumericInstance.clear();

Особенности:

  • Может устанавливать ноль вместо пустого значения, если это предусмотрено конфигурацией
  • Обновляет DOM-элемент
  • Сбрасывает внутреннее состояние текущего значения

Пример:

autoNumericInstance.clear();

wipe()

Метод wipe выполняет более «жёсткую» очистку состояния по сравнению с clear, включая сброс форматирования и внутренних буферов.

Сигнатура:

autoNumericInstance.wipe();

Отличия от clear:

  • Удаляет значение полностью, без интерпретации нуля
  • Может использоваться при полной перезагрузке данных формы
  • Очищает не только значение, но и вспомогательные представления

update(settings)

Метод update изменяет конфигурацию уже существующего экземпляра без его пересоздания.

Сигнатура:

autoNumericInstance.update(newSettings);

Поведение:

  • Применяет новые параметры форматирования
  • Пересчитывает текущее значение под новые правила
  • Не пересоздаёт DOM-элемент
  • Может частично переинициализировать внутренние вычисления

Пример:

autoNumericInstance.update({
  decimalCharacter: ",",
  digitGroupSeparator: " "
});

Метод используется для динамического изменения поведения ввода, например при смене локали.

reformat()

Метод reformat принудительно применяет форматирование к текущему значению, даже если оно уже отформатировано.

Сигнатура:

autoNumericInstance.reformat();

Сценарии применения:

  • После программного изменения DOM-значения
  • При синхронизации внешних данных
  • При изменении настроек, требующих пересчёта отображения

Особенность:

  • Не изменяет значение, только его визуальное представление

unformat()

Метод unformat переводит значение в неформатированное состояние, временно убирая визуальные элементы оформления.

Сигнатура:

autoNumericInstance.unformat();

Поведение:

  • Удаляет групповые разделители и символы
  • Подготавливает значение к редактированию или вычислениям
  • Может использоваться перед сериализацией данных

format()

Метод format выполняет обратную операцию к unformat, приводя значение к отображаемому виду.

Сигнатура:

autoNumericInstance.format();

Особенности:

  • Применяет текущие настройки форматирования
  • Обновляет DOM-элемент
  • Используется для восстановления визуального состояния после программных изменений

isEmpty()

Метод isEmpty проверяет, содержит ли поле значение, интерпретируемое как пустое.

Сигнатура:

autoNumericInstance.isEmpty();

Возвращаемое значение:

  • true — если значение отсутствует или соответствует пустому состоянию
  • false — если присутствует валидное число

getSettings()

Метод getSettings возвращает текущую конфигурацию экземпляра.

Сигнатура:

autoNumericInstance.getSettings();

Содержимое:

  • Все активные параметры форматирования
  • Производные настройки, применённые при инициализации
  • Локальные изменения, внесённые через update

remove()

Метод remove полностью отключает AutoNumeric от элемента.

Сигнатура:

autoNumericInstance.remove();

Действия:

  • Удаляет привязку к input-элементу
  • Очищает внутренние слушатели событий
  • Возвращает элемент к обычному состоянию ввода

Статические методы управления экземплярами

Помимо методов экземпляра, библиотека предоставляет статические функции для работы с уже созданными объектами AutoNumeric.

AutoNumeric.getAutoNumericElement()

Позволяет получить экземпляр AutoNumeric, привязанный к DOM-элементу.

const instance = AutoNumeric.getAutoNumericElement(domElement);

AutoNumeric.isManagedByAutoNumeric()

Проверяет, управляется ли элемент библиотекой.

const result = AutoNumeric.isManagedByAutoNumeric(domElement);

AutoNumeric.multiple()

Метод для инициализации нескольких элементов с одинаковой конфигурацией.

AutoNumeric.multiple(selector, configuration);

Публичный API методов формирует основу взаимодействия с библиотекой, обеспечивая контроль над значением, представлением и жизненным циклом числовых полей без необходимости прямого манипулирования DOM или ручной обработки форматирования.

Оглавление