API локализации

По умолчанию Vega форматирует числа и даты по правилам американского английского языка. Для визуализаций на других языках эти настройки можно изменить. Для форматирования Vega использует библиотеки D3 d3-format и d3-time-format.

Методы ниже позволяют изменить локаль по умолчанию для всех визуализаций. Чтобы задать локаль отдельного представления, укажите параметр конфигурации locale или параметр locale конструктора View.

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

Настройка локали

# vega.formatLocale([definition]) Исходный код

Возвращает или задаёт локаль по умолчанию для форматирования чисел. Без аргументов возвращает текущую локаль. Если передать definition, задаёт локаль на его основе и возвращает полученный объект локали. Определение должно соответствовать формату библиотеки d3-format. Примеры определений для разных языков доступны в коллекции локалей d3-format. Чтобы одновременно задать локали для чисел и времени, используйте метод defaultLocale.

# vega.timeFormatLocale([definition]) Исходный код

Возвращает или задаёт локаль по умолчанию для форматирования времени. Без аргументов возвращает текущую локаль. Если передать definition, задаёт локаль на его основе и возвращает полученный объект локали. Определение должно соответствовать формату библиотеки d3-time-format. Примеры определений для разных языков доступны в коллекции локалей d3-time-format. Чтобы одновременно задать локали для чисел и времени, используйте метод defaultLocale.

Объединённая локаль ≥ 5.12

Объект объединённой локали содержит методы форматирования чисел и времени в одном объекте. Он объединяет методы соответствующих объектов локализации.

# vega.locale(numberDefinition, timeDefinition) Исходный код

Создаёт объединённый объект локали для форматирования чисел и времени на основе numberDefinition и timeDefinition. Определения должны соответствовать форматам библиотек d3-format и d3-time-format. Если аргумент не указан или равен null, для соответствующего вида значений используется текущая локаль по умолчанию. Примеры определений для разных языков доступны в коллекциях локалей d3-format и d3-time-format.

Например, так можно создать локаль для форматирования чисел и времени на немецком языке:

const deDE = vega.locale(
  {
    decimal: ',',
    thousands: '.',
    grouping: [3],
    currency: ['', '\u00a0€']
  },
  {
    dateTime: '%A, der %e. %B %Y, %X',
    date: '%d.%m.%Y',
    time: '%H:%M:%S',
    periods: ['AM', 'PM'],
    days: [
      'Sonntag', 'Montag', 'Dienstag', 'Mittwoch',
      'Donnerstag', 'Freitag', 'Samstag'
    ],
    shortDays: ['So', 'Mo', 'Di', 'Mi', 'Do', 'Fr', 'Sa'],
    months: [
      'Januar', 'Februar', 'März',
      'April', 'Mai', 'Juni',
      'Juli', 'August', 'September',
      'Oktober', 'November', 'Dezember'
    ],
    shortMonths: [
      'Jan', 'Feb', 'Mrz', 'Apr', 'Mai', 'Jun',
      'Jul', 'Aug', 'Sep', 'Okt', 'Nov', 'Dez'
    ]
  }
);

# vega.defaultLocale([numberDefinition, timeDefinition]) Исходный код

Возвращает или задаёт локаль по умолчанию для форматирования чисел и времени. Без аргументов возвращает текущую локаль. Если передать numberDefinition и timeDefinition, задаёт локали на их основе и возвращает объединённый объект локали. Тип определений должен соответствовать требованиям метода locale.

# vega.resetDefaultLocale() Исходный код

Сбрасывает локали по умолчанию для чисел и времени и возвращает полученный объединённый объект локали. После сброса настройки Vega совпадают с текущими локалями библиотек d3-format и d3-time-format.