Class Format

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Формат

Средство форматирования для вывода XML-документа с тремя предопределенными форматами, которые можно дополнительно настроить.

// Log an XML document with specified formatting options.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getCompactFormat()
    .setLineSeparator('\n')
    .setEncoding('UTF-8')
    .setIndent('   ')
    .format(document);
Logger.log(output);

Методы

Метод Тип возврата Краткое описание
format(document) String Выводит данный Document в виде форматированной строки.
format(element) String Выводит данный узел Element в виде форматированной строки.
setEncoding(encoding) Format Устанавливает кодировку символов, которую должен использовать модуль форматирования.
setIndent(indent) Format Задает строку, используемую для отступа дочерних узлов относительно их родителей.
setLineSeparator(separator) Format Устанавливает строку для вставки всякий раз, когда средство форматирования обычно вставляет разрыв строки.
setOmitDeclaration(omitDeclaration) Format Устанавливает, должен ли модуль форматирования пропускать объявление XML, например <?xml version="1.0" encoding="UTF-8"?> .
setOmitEncoding(omitEncoding) Format Устанавливает, должен ли модуль форматирования пропускать кодировку в объявлении XML, например поле кодировки в <?xml version="1.0" encoding="UTF-8"?> .

Подробная документация

format(document)

Выводит данный Document в виде форматированной строки.

Параметры

Имя Тип Описание
document Document документ для форматирования

Возвращаться

String — форматированный документ


format(element)

Выводит данный узел Element в виде форматированной строки.

Параметры

Имя Тип Описание
element Element элемент для форматирования

Возвращаться

String — форматируемый элемент


setEncoding(encoding)

Устанавливает кодировку символов, которую должен использовать модуль форматирования. Аргумент encoding должен быть допустимой кодировкой XML, такой как ISO-8859-1 , US-ASCII , UTF-8 или UTF-16 .

// Log an XML document with encoding that does not support certain special characters.
var xml = '<root><a><b>ಠ‿ಠ</b><b>ಠ‿ಠ</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getRawFormat()
    .setEncoding('ISO-8859-1')
    .format(document);
Logger.log(output);

Параметры

Имя Тип Описание
encoding String кодировка для использования

Возвращаться

Format — форматер, для объединения в цепочку


setIndent(indent)

Задает строку, используемую для отступа дочерних узлов относительно их родителей. Установка отступа, отличного от null , приведет к тому, что средство форматирования вставит разрыв строки после каждого узла.

// Log an XML document with each child node indented four spaces.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getCompactFormat()
    .setIndent('    ')
    .format(document);
Logger.log(output);

Параметры

Имя Тип Описание
indent String отступ для использования

Возвращаться

Format — форматер, для объединения в цепочку


setLineSeparator(separator)

Устанавливает строку для вставки всякий раз, когда средство форматирования обычно вставляет разрыв строки. Три предопределенных средства форматирования имеют разные условия, при которых они вставляют разрыв строки. Разделитель строк по умолчанию — \r\n .

// Log an XML document with several spaces and a pipe character in place of line breaks.
var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getRawFormat()
    .setLineSeparator(' | ')
    .format(document);
Logger.log(output);

Параметры

Имя Тип Описание
separator String разделитель для использования

Возвращаться

Format — форматер, для объединения в цепочку


setOmitDeclaration(omitDeclaration)

Устанавливает, должен ли модуль форматирования пропускать объявление XML, например <?xml version="1.0" encoding="UTF-8"?> .

Параметры

Имя Тип Описание
omitDeclaration Boolean Значение true , чтобы пропустить объявление XML; false , чтобы включить его

Возвращаться

Format — форматер, для объединения в цепочку


setOmitEncoding(omitEncoding)

Устанавливает, должен ли модуль форматирования пропускать кодировку в объявлении XML, например поле кодировки в <?xml version="1.0" encoding="UTF-8"?> .

Параметры

Имя Тип Описание
omitEncoding Boolean Значение true , чтобы пропустить кодировку в объявлении XML; false , чтобы включить его

Возвращаться

Format — форматер, для объединения в цепочку