You are here

Home » API reference » Views data export 8

views_data_export.views.schema.yml in Views data export 8

config/schema/views_data_export.views.schema.yml

File

config/schema/views_data_export.views.schema.yml
View source 
  1. # Schema for the views plugins of the Views Data Export module.

  2. 

  3. views.display.data_export:

  4.   type: views.display.rest_export

  5.   label: 'Data export display options'

  6.   mapping:

  7.     displays:

  8.       type: sequence

  9.       label: 'Attach to'

  10.       sequence:

  11.         type: string

  12.         label: 'Display'

  13.     filename:

  14.       type: string

  15.       label: 'Downloaded filename'

  16.     automatic_download:

  17.       type: boolean

  18.       label: 'Download immediately'

  19.     redirect_path:

  20.       type: string

  21.       label: 'Redirect path'

  22.     export_method:

  23.       type: string

  24.       label: 'Export method'

  25.     export_batch_size:

  26.       type: integer

  27.       label: 'Batch size'

  28.     export_limit:

  29.       type: integer

  30.       label: 'Limit'

  31.     facet_settings:

  32.       type: string

  33.       label: 'Facet sources'

  34.     store_in_public_file_directory:

  35.       type: boolean

  36.       label: 'Allow anonymous users to download this file'

  37.     custom_redirect_path:

  38.       type: boolean

  39.       label: 'Custom redirect path'

  40.     redirect_to_display:

  41.       type: string

  42.       label: 'Redirect to this display'

  43.     include_query_params:

  44.       type: boolean

  45.       label: 'Include query string parameters on redirect'

  46. 

  47. views.style.data_export:

  48.   type: views_style

  49.   label: 'Data export output format'

  50.   mapping:

  51.     formats:

  52.       type: sequence

  53.       label: 'Formats'

  54.       sequence:

  55.         type: string

  56.         label: 'Format'

  57.     csv_settings:

  58.       type: mapping

  59.       label: 'CSV settings'

  60.       mapping:

  61.         delimiter:

  62.           type: string

  63.           label: 'Delimiter'

  64.         enclosure:

  65.           type: string

  66.           label: 'Enclosure'

  67.         escape_char:

  68.           type: string

  69.           label: 'Escape character'

  70.         strip_tags:

  71.           type: boolean

  72.           label: 'Strip HTML'

  73.         trim:

  74.           type: boolean

  75.           label: 'Trim whitespace'

  76.         encoding:

  77.           type: string

  78.           label: 'Encoding'

  79.         utf8_bom:

  80.           type: string

  81.           label: 'Include unicode signature (BOM)'

  82.         use_serializer_encode_only:

  83.           type: boolean

  84.           label: 'Only use serializer->encode method'

  85.     xls_settings:

  86.       type: mapping

  87.       label: 'XLS settings'

  88.       mapping:

  89.         xls_format:

  90.           type: string

  91.           label: 'Format'

  92.         metadata:

  93.           type: mapping

  94.           label: 'Metadata'

  95.           mapping:

  96.             creator:

  97.               type: string

  98.               label: 'Creator'

  99.             last_modified_by:

  100.               type: string

  101.               label: 'Last modified by'

  102.             title:

  103.               type: string

  104.               label: 'Title'

  105.             description:

  106.               type: string

  107.               label: 'Description'

  108.             subject:

  109.               type: string

  110.               label: 'Subject'

  111.             keywords:

  112.               type: string

  113.               label: 'Keywords'

  114.             category:

  115.               type: string

  116.               label: 'Category'

  117.             manager:

  118.               type: string

  119.               label: 'Manager'

  120.             company:

  121.               type: string

  122.               label: 'Company'