mlreportgen.dom.Watermark class

Пакет: mlreportgen.dom
Суперклассы:

Добавление водяного знака на страницы в разделах отчетов PDF

Описание

Создает объект водяного знака, который можно добавить в раздел отчета PDF. Водяной знак - это изображение, которое появляется в фоновом режиме страницы, например, слово Draft или Confidential. Он запускается за текстом на каждой странице, к которой он применяется. Можно использовать любой из следующих типов файлов: .bmp, .jpg, .png, .svg, и .tiff.

Конструкция

wm = Watermark(image) создает Watermark объект на основе заданного изображения и возвращает Watermark объект.

Входные параметры

расширить все

Изображение для использования в качестве водяного знака, заданное как имя пути к изображению. Используйте любой из следующих типов файлов:

  • .bmp

  • .jpg

  • .pdf (только для типов выходных документов PDF)

  • .png

  • .svg

  • .tiff

Свойства

расширить все

Вектор символов в форме valueUnits. Используйте любое из следующих значений для модулей:

  • px - пиксели (по умолчанию)

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметры

  • pc - picas

  • pt - точки

Также можно задать высоту с помощью Watermark.Style свойство. Для примера:

Watermark.Style = {Height('4in')};

Идентификатор для этого элемента документа, заданный как вектор символов или строковый скаляр. DOM генерирует уникальный идентификатор сеанса при создании элемента документа. Вы можете задать свой собственный идентификатор.

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

Форматирование объектов, задающих формат элемента документа.

Тег для этого элемента документа, заданный как вектор символов или строковый скаляр.

DOM генерирует тег с уникальным сеансом как часть создания этого объекта. Сгенерированный тег имеет форму CLASS: ID, где CLASS является классом объекта, а ID является значением Id свойство объекта. Определение собственного значения тега может помочь вам определить, где произошла проблема во время генерации документа.

Ширина водяного знака, заданная в виде вектора символов в форме valueUnits. Используйте любое из следующих значений для модулей:

  • px - пиксели (по умолчанию)

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметры

  • pc - picas

  • pt - точки

Также можно задать ширину с помощью Watermark.Style свойство. Для примера:

Watermark.Style = {Width('4in')};

Примеры

свернуть все

В этом примере показано, как создать водяной знак программно и затем применить его к текущему размещению. Создание водяного знака программно упрощает управление файлами, потому что вам не нужно хранить файл изображения и отслеживать его расположение.

Используя команды MATLAB ®, создайте файл изображения программно. Использование SVG файл изображения поддерживает разрешение при масштабировании изображения. После записи изображения в файл можно удалить рисунок.

 wmname = 'wm';
 wmtype =  'svg';
 wmfilename = [wmname '.' wmtype];

 subplot('Position',[0, 0, 1, 1]);
 axis('off');
 text(0.25, 0.25,'Draft', ...
   'Rotation', 45, ...
   'Color', [0.85, 0.85, 0.85], ...
   'FontSize',72);

  print(wmfilename, ['-d' wmtype]);
  delete(gcf);

Создайте объект водяного знака wm и применить его к текущему макету страницы. После генерации отчета можно удалить файл изображения, заданный переменной wmfilename.

import mlreportgen.dom.*;

d = Document('myreport','pdf');
open(d);

wm = Watermark(wmfilename);
wm.Width = '12in';
wm.Height = [];

d.CurrentPageLayout.Watermark = wm;

append(d,'Hello');
append(d, PageBreak);
append(d,'World');

close(d);
rptview(d.OutputPath);
delete(wmfilename);
Введенный в R2016b