You are here

Home » API reference » Entity Print 8.2

entity_print.schema.yml in Entity Print 8.2

Same filename and directory in other branches
  1. 8 config/schema/entity_print.schema.yml
config/schema/entity_print.schema.yml

File

config/schema/entity_print.schema.yml
View source 
  1. entity_print.settings:

  2.   type: config_object

  3.   label: 'Entity Print settings.'

  4.   mapping:

  5.     default_css:

  6.       type: boolean

  7.       label: 'Enable the default CSS.'

  8.     force_download:

  9.       type: boolean

  10.       label: 'Force download of Print'

  11.     print_engines:

  12.       type: sequence

  13.       label: 'All in-use print engines.'

  14.       sequence:

  15.         type: string

  16. 

  17. entint_print_engine_pdf:

  18.   type: mapping

  19.   label: 'Base settings for engines using the PDF base class'

  20.   mapping:

  21.     default_paper_size:

  22.       type: string

  23.       label: 'Default Paper Size'

  24.     orientation:

  25.       type: string

  26.       label: 'Paper Orientation'

  27.     username:

  28.       type: string

  29.       label: 'HTTP Auth username'

  30.     password:

  31.       type: string

  32.       label: 'HTTP Auth password'

  33. 

  34. entity_print.print_engine.*:

  35.   type: config_entity

  36.   label: 'Print Engine'

  37.   mapping:

  38.     id:

  39.       type: string

  40.       label: 'Print Engine Id'

  41.     settings:

  42.       type: entity_print_print_engine.[%parent.id]

  43.       label: 'Settings for the Print Engine.'

  44. 

  45. entity_print_print_engine.dompdf:

  46.   type: entint_print_engine_pdf

  47.   label: 'Dompdf specific settings'

  48.   mapping:

  49.     enable_html5_parser:

  50.       type: boolean

  51.       label: 'Enable HTML5 parsing'

  52.     enable_remote:

  53.       type: boolean

  54.       label: 'Enable remote urls'

  55.     cafile:

  56.       type: string

  57.       label: 'Path to the cafile'

  58.     verify_peer:

  59.       type: boolean

  60.       label: 'Verify Peer'

  61.     verify_peer_name:

  62.       type: boolean

  63.       label: 'Verify Peer Name'

  64. 

  65. entity_print_print_engine.phpwkhtmltopdf:

  66.   type: entint_print_engine_pdf

  67.   label: 'PHP Wkhtmltopdf'

  68.   mapping:

  69.     binary_location:

  70.       type: string

  71.       label: 'Path to the wkhtmltopdf binary'

  72.     toc_generate:

  73.       type: boolean

  74.       label: 'Generate table of content'

  75.     toc_enable_back_links:

  76.       type: boolean

  77.       label: 'Link from section header to table of content'

  78.     toc_disable_dotted_lines:

  79.       type: boolean

  80.       label: 'Do not use dotted lines in the table of content'

  81.     toc_disable_links:

  82.       type: boolean

  83.       label: 'Do not link from table of content to sections'

  84.     viewport_size:

  85.       type: string

  86.       label: 'Set viewport size if you have custom scrollbars or css attribute overflow to emulate window size.'

  87.     remove_pdf_margins:

  88.       type: boolean

  89.       label: 'Remove the page margins on the PDF'

  90. 

  91. entity_print_print_engine.tcpdfv1:

  92.   label: 'TCPDF (v1)'

  93.   type: mapping

  94.   mapping:

  95.     page_format:

  96.       type: string

  97.       label: 'The page format. E.g. A3, A4 or many more options'

  98.     orientation:

  99.       type: string

  100.       label: 'Paper Orientation'

  101. 

  102. # Add schema for our extra field settings.

  103. core.entity_view_display.*.*.*.third_party.entity_print:

  104.   type: sequence

  105.   label: 'Schema for Entity Print third party settings'

  106.   sequence:

  107.     type: string

  108.     label: 'Entity print settings for each export type'

  109. 

  110. action.configuration.entity_print_download_action:

  111.   type: action_configuration_default

  112.   label: 'Print Action'

  113. 

  114. field.formatter.settings.entity_print_base64_image_formatter:

  115.   type: mapping

  116.   label: 'Image field display format settings'

  117.   mapping:

  118.     image_style:

  119.       type: string

  120.       label: 'Image style'

  121. 

  122. block.settings.print_links:

  123.   type: block_settings

  124.   label: 'Print Links'

  125.   mapping:

  126.     pdf_enabled:

  127.       type: boolean

  128.       label: 'Flag to enable PDF link'

  129.     pdf_link_text:

  130.       type: label

  131.       label: 'PDF link text'

  132.     epub_enabled:

  133.       type: boolean

  134.       label: 'Flag to enable EPub link'

  135.     epub_link_text:

  136.       type: label

  137.       label: 'EPub link text'

  138.     word_docx_enabled:

  139.       type: boolean

  140.       label: 'Flag to enable Word Document link'

  141.     word_docx_link_text:

  142.       type: label

  143.       label: 'Word Document link text'