views.data_types.schema.yml

Same filename in other branches
  1. 9 core/modules/views/config/schema/views.data_types.schema.yml
  2. 10 core/modules/views/config/schema/views.data_types.schema.yml
  3. 11.x core/modules/views/config/schema/views.data_types.schema.yml
core/modules/views/config/schema/views.data_types.schema.yml

File

core/modules/views/config/schema/views.data_types.schema.yml

View source
  1. # Basic data types for views.
  2. views_display:
  3. type: mapping
  4. label: 'Display options'
  5. mapping:
  6. enabled:
  7. type: boolean
  8. label: 'Status'
  9. title:
  10. type: text
  11. label: 'Display title'
  12. format:
  13. type: string
  14. label: 'Format'
  15. fields:
  16. type: sequence
  17. label: 'Fields'
  18. sequence:
  19. type: views.field.[plugin_id]
  20. pager:
  21. type: mapping
  22. label: 'Pager'
  23. mapping:
  24. type:
  25. type: string
  26. label: 'Pager type'
  27. options:
  28. type: views.pager.[%parent.type]
  29. exposed_form:
  30. type: mapping
  31. label: 'Exposed form'
  32. mapping:
  33. type:
  34. type: string
  35. label: 'Exposed form type'
  36. options:
  37. label: 'Options'
  38. type: views.exposed_form.[%parent.type]
  39. access:
  40. type: mapping
  41. label: 'Access'
  42. mapping:
  43. type:
  44. type: string
  45. label: 'Access type'
  46. options:
  47. type: views.access.[%parent.type]
  48. cache:
  49. type: views.cache.[type]
  50. empty:
  51. type: sequence
  52. label: 'No results behavior'
  53. sequence:
  54. type: views.area.[plugin_id]
  55. sorts:
  56. type: sequence
  57. label: 'Sorts'
  58. sequence:
  59. type: views.sort.[plugin_id]
  60. arguments:
  61. type: sequence
  62. label: 'Arguments'
  63. sequence:
  64. type: views.argument.[plugin_id]
  65. filters:
  66. type: sequence
  67. label: 'Filters'
  68. sequence:
  69. type: views.filter.[plugin_id]
  70. filter_groups:
  71. type: mapping
  72. label: 'Groups'
  73. mapping:
  74. operator:
  75. type: string
  76. label: 'Operator'
  77. groups:
  78. type: sequence
  79. label: 'Groups'
  80. sequence:
  81. type: string
  82. label: 'Operator'
  83. style:
  84. type: mapping
  85. label: 'Format'
  86. mapping:
  87. type:
  88. type: string
  89. label: 'Type'
  90. options:
  91. type: views.style.[%parent.type]
  92. row:
  93. type: mapping
  94. label: 'Row'
  95. mapping:
  96. type:
  97. type: string
  98. label: 'Row type'
  99. options:
  100. type: views.row.[%parent.type]
  101. query:
  102. type: mapping
  103. label: 'Query'
  104. mapping:
  105. type:
  106. type: string
  107. label: 'Query type'
  108. options:
  109. type: views.query.[%parent.type]
  110. defaults:
  111. type: mapping
  112. label: 'Defaults'
  113. mapping:
  114. empty:
  115. type: boolean
  116. label: 'Empty'
  117. access:
  118. type: boolean
  119. label: 'Access restrictions'
  120. cache:
  121. type: boolean
  122. label: 'Caching'
  123. query:
  124. type: boolean
  125. label: 'Query options'
  126. title:
  127. type: boolean
  128. label: 'Title'
  129. css_class:
  130. type: boolean
  131. label: 'CSS class'
  132. display_description:
  133. type: boolean
  134. label: 'Administrative description'
  135. use_ajax:
  136. type: boolean
  137. label: 'Use AJAX'
  138. hide_attachment_summary:
  139. type: boolean
  140. label: 'Hide attachments when displaying a contextual filter summary'
  141. show_admin_links:
  142. type: boolean
  143. label: 'Show contextual links'
  144. pager:
  145. type: boolean
  146. label: 'Use pager'
  147. use_more:
  148. type: boolean
  149. label: 'Create more link'
  150. use_more_always:
  151. type: boolean
  152. label: 'Display ''more'' link only if there is more content'
  153. use_more_text:
  154. type: boolean
  155. label: 'The text to display for the more link.'
  156. exposed_form:
  157. type: boolean
  158. label: 'Exposed form style'
  159. link_display:
  160. type: boolean
  161. label: 'Link display'
  162. link_url:
  163. type: boolean
  164. label: 'Link URL'
  165. group_by:
  166. type: boolean
  167. label: 'Aggregate'
  168. style:
  169. type: boolean
  170. label: 'Style'
  171. row:
  172. type: boolean
  173. label: 'Row'
  174. relationships:
  175. type: boolean
  176. label: 'Relationships'
  177. fields:
  178. type: boolean
  179. label: 'Fields'
  180. sorts:
  181. type: boolean
  182. label: 'Sorts'
  183. arguments:
  184. type: boolean
  185. label: 'Arguments'
  186. filters:
  187. type: boolean
  188. label: 'Filters'
  189. filter_groups:
  190. type: boolean
  191. label: 'Filter groups'
  192. header:
  193. type: boolean
  194. label: 'Header'
  195. footer:
  196. type: boolean
  197. label: 'Footer'
  198. relationships:
  199. type: sequence
  200. label: 'Relationships'
  201. sequence:
  202. type: views.relationship.[plugin_id]
  203. css_class:
  204. type: string
  205. label: 'CSS class'
  206. use_ajax:
  207. type: boolean
  208. label: 'Use AJAX'
  209. group_by:
  210. type: boolean
  211. label: 'Aggregate'
  212. display_description:
  213. type: label
  214. label: 'Administrative description'
  215. show_admin_links:
  216. type: boolean
  217. label: 'Show contextual links'
  218. use_more:
  219. type: boolean
  220. label: 'Create more link'
  221. use_more_always:
  222. type: boolean
  223. label: 'Display ''more'' link only if there is more content'
  224. use_more_text:
  225. type: label
  226. label: 'The text to display for the more link.'
  227. link_display:
  228. type: string
  229. label: 'Link display'
  230. link_url:
  231. type: string
  232. label: 'Link URL'
  233. header:
  234. type: sequence
  235. label: 'Header'
  236. sequence:
  237. type: views.area.[plugin_id]
  238. footer:
  239. type: sequence
  240. label: 'Footer'
  241. sequence:
  242. type: views.area.[plugin_id]
  243. display_comment:
  244. type: label
  245. label: 'Display comment'
  246. hide_attachment_summary:
  247. type: boolean
  248. label: 'Hide attachments in summary'
  249. rendering_language:
  250. type: string
  251. label: 'Entity language'
  252. exposed_block:
  253. type: boolean
  254. label: 'Put the exposed form in a block'
  255. display_extenders:
  256. type: sequence
  257. label: 'Display extenders'
  258. sequence:
  259. type: views.display_extender.[%key]
  260. views_sort:
  261. type: views_handler
  262. label: 'Sort criteria'
  263. mapping:
  264. order:
  265. type: string
  266. label: 'Sort order'
  267. expose:
  268. type: views.sort_expose.[%parent.plugin_id]
  269. exposed:
  270. type: boolean
  271. label: 'Expose this sort to visitors, to allow them to change it'
  272. plugin_id:
  273. type: string
  274. label: 'Plugin ID'
  275. views_sort_expose:
  276. type: mapping
  277. mapping:
  278. label:
  279. type: label
  280. label: 'Label'
  281. views_area:
  282. type: views_handler
  283. label: 'Area'
  284. mapping:
  285. label:
  286. type: label
  287. label: 'A string to identify the area instance in the admin UI.'
  288. empty:
  289. type: boolean
  290. label: 'Should the area be displayed on empty results.'
  291. plugin_id:
  292. type: string
  293. label: 'Plugin ID'
  294. views_handler:
  295. type: mapping
  296. mapping:
  297. id:
  298. type: string
  299. label: 'A unique ID per handler type'
  300. table:
  301. type: string
  302. label: 'The views_data table for this handler'
  303. field:
  304. type: string
  305. label: 'The views_data field for this handler'
  306. relationship:
  307. type: string
  308. label: 'The ID of the relationship instance used by this handler'
  309. group_type:
  310. type: string
  311. label: 'A sql aggregation type'
  312. admin_label:
  313. type: label
  314. label: 'A string to identify the handler instance in the admin UI.'
  315. entity_type:
  316. type: string
  317. label: 'The entity type'
  318. entity_field:
  319. type: string
  320. label: 'The corresponding entity field'
  321. plugin_id:
  322. type: string
  323. label: 'The plugin ID'
  324. views_argument:
  325. type: views_handler
  326. label: 'Argument'
  327. mapping:
  328. default_action:
  329. type: string
  330. label: 'When the filter value is NOT available'
  331. exception:
  332. type: mapping
  333. label: 'Exception value'
  334. mapping:
  335. value:
  336. type: string
  337. label: 'Value'
  338. title_enable:
  339. type: boolean
  340. label: 'Override title'
  341. title:
  342. type: label
  343. label: 'Title'
  344. title_enable:
  345. type: boolean
  346. label: 'Override title'
  347. title:
  348. type: label
  349. label: 'Overridden title'
  350. default_argument_type:
  351. type: string
  352. label: 'Type'
  353. default_argument_options:
  354. type: views.argument_default.[%parent.default_argument_type]
  355. label: 'Default argument options'
  356. default_argument_skip_url:
  357. type: boolean
  358. label: 'Skip default argument for view URL'
  359. summary_options:
  360. type: views.style.[%parent.summary.format]
  361. label: 'Summary options'
  362. summary:
  363. type: mapping
  364. label: 'Display a summary'
  365. mapping:
  366. sort_order:
  367. type: string
  368. label: 'Sort order'
  369. number_of_records:
  370. type: integer
  371. label: 'Sort by'
  372. format:
  373. type: string
  374. label: 'Format'
  375. specify_validation:
  376. type: boolean
  377. label: 'Specify validation criteria'
  378. validate:
  379. type: mapping
  380. label: 'Validation settings'
  381. mapping:
  382. type:
  383. type: string
  384. label: 'Validator'
  385. fail:
  386. type: string
  387. label: 'Action to take if filter value does not validate'
  388. validate_options:
  389. type: views.argument_validator.[%parent.validate.type]
  390. label: 'Validate options'
  391. glossary:
  392. type: boolean
  393. label: 'Glossary mode'
  394. limit:
  395. type: integer
  396. label: 'Character limit'
  397. case:
  398. type: string
  399. label: 'Case'
  400. path_case:
  401. type: string
  402. label: 'Case in path'
  403. transform_dash:
  404. type: boolean
  405. label: 'Transform spaces to dashes in URL'
  406. break_phrase:
  407. type: boolean
  408. label: 'Allow multiple values'
  409. plugin_id:
  410. type: string
  411. label: 'Plugin ID'
  412. views_exposed_form:
  413. type: mapping
  414. mapping:
  415. submit_button:
  416. type: label
  417. label: 'Submit button text'
  418. reset_button:
  419. type: boolean
  420. label: 'Include reset button'
  421. reset_button_label:
  422. type: label
  423. label: 'Reset button label'
  424. exposed_sorts_label:
  425. type: label
  426. label: 'Exposed sorts label'
  427. expose_sort_order:
  428. type: boolean
  429. label: 'Expose sort order'
  430. sort_asc_label:
  431. type: label
  432. label: 'Ascending'
  433. sort_desc_label:
  434. type: label
  435. label: 'Descending'
  436. views_field:
  437. type: views_handler
  438. mapping:
  439. label:
  440. type: label
  441. label: 'Create a label'
  442. exclude:
  443. type: boolean
  444. label: 'Exclude from display'
  445. alter:
  446. type: mapping
  447. label: 'Rewrite results'
  448. mapping:
  449. alter_text:
  450. type: boolean
  451. label: 'Override the output of this field with custom text'
  452. text:
  453. type: text
  454. label: 'Text'
  455. make_link:
  456. type: boolean
  457. label: 'Output this field as a custom link'
  458. path:
  459. type: string
  460. label: 'Link path'
  461. absolute:
  462. type: boolean
  463. label: 'Use absolute path'
  464. external:
  465. type: boolean
  466. label: 'External server URL'
  467. replace_spaces:
  468. type: boolean
  469. label: 'Replace spaces with dashes'
  470. path_case:
  471. type: string
  472. label: 'Transform the case'
  473. trim_whitespace:
  474. type: boolean
  475. label: 'Remove whitespace'
  476. alt:
  477. type: label
  478. label: 'Title text'
  479. rel:
  480. type: string
  481. label: 'Rel Text'
  482. link_class:
  483. type: string
  484. label: 'Link class'
  485. prefix:
  486. type: label
  487. label: 'Prefix text'
  488. suffix:
  489. type: label
  490. label: 'Suffix text'
  491. target:
  492. type: string
  493. label: 'Target'
  494. nl2br:
  495. type: boolean
  496. label: 'Convert newlines to HTML <br> tags'
  497. max_length:
  498. type: integer
  499. label: 'Maximum number of characters'
  500. word_boundary:
  501. type: boolean
  502. label: 'Trim only on a word boundary'
  503. ellipsis:
  504. type: boolean
  505. label: 'Add "…" at the end of trimmed text'
  506. more_link:
  507. type: boolean
  508. label: 'Add a read-more link if output is trimmed'
  509. more_link_text:
  510. type: label
  511. label: 'More link label'
  512. more_link_path:
  513. type: string
  514. label: 'More link path'
  515. strip_tags:
  516. type: boolean
  517. label: 'Strip HTML tags'
  518. trim:
  519. type: boolean
  520. label: 'Trim this field to a maximum number of characters'
  521. preserve_tags:
  522. type: string
  523. label: 'Preserve certain tags'
  524. html:
  525. type: boolean
  526. label: 'Field can contain HTML'
  527. element_type:
  528. type: string
  529. label: 'HTML element'
  530. element_class:
  531. type: string
  532. label: 'CSS class'
  533. element_label_type:
  534. type: string
  535. label: 'Label HTML element'
  536. element_label_class:
  537. type: string
  538. label: 'CSS class'
  539. element_label_colon:
  540. type: boolean
  541. label: 'Place a colon after the label'
  542. element_wrapper_type:
  543. type: string
  544. label: 'Wrapper HTML element'
  545. element_wrapper_class:
  546. type: string
  547. label: 'CSS class'
  548. element_default_classes:
  549. type: boolean
  550. label: 'Add default classes'
  551. empty:
  552. type: string
  553. label: 'No results text'
  554. hide_empty:
  555. type: boolean
  556. label: 'Hide if empty'
  557. empty_zero:
  558. type: boolean
  559. label: 'Count the number 0 as empty'
  560. hide_alter_empty:
  561. type: boolean
  562. label: 'Hide rewriting if empty'
  563. destination:
  564. type: boolean
  565. label: 'Append a destination query string to operation links.'
  566. plugin_id:
  567. type: string
  568. label: 'Plugin ID'
  569. views_pager:
  570. type: mapping
  571. label: 'Pager'
  572. mapping:
  573. offset:
  574. type: integer
  575. label: 'Offset'
  576. items_per_page:
  577. type: integer
  578. label: 'Items per page'
  579. views_pager_sql:
  580. type: views_pager
  581. label: 'SQL pager'
  582. mapping:
  583. items_per_page:
  584. type: integer
  585. label: 'Items per page'
  586. total_pages:
  587. type: integer
  588. label: 'Number of pages'
  589. id:
  590. type: integer
  591. label: 'Pager ID'
  592. tags:
  593. type: mapping
  594. label: 'Pager link labels'
  595. mapping:
  596. next:
  597. type: label
  598. label: 'Next page link text'
  599. previous:
  600. type: label
  601. label: 'Previous page link text'
  602. quantity:
  603. type: integer
  604. label: 'Number of pager links visible'
  605. expose:
  606. type: mapping
  607. label: 'Exposed options'
  608. mapping:
  609. items_per_page:
  610. type: boolean
  611. label: 'Items per page'
  612. items_per_page_label:
  613. type: label
  614. label: 'Items per page label'
  615. items_per_page_options:
  616. type: string
  617. label: 'Exposed items per page options'
  618. items_per_page_options_all:
  619. type: boolean
  620. label: 'Include all items option'
  621. items_per_page_options_all_label:
  622. type: label
  623. label: 'All items label'
  624. offset:
  625. type: boolean
  626. label: 'Expose Offset'
  627. offset_label:
  628. type: label
  629. label: 'Offset label'
  630. views_style:
  631. type: mapping
  632. mapping:
  633. grouping:
  634. type: sequence
  635. label: 'Grouping field number %i'
  636. sequence:
  637. type: mapping
  638. label: 'Field'
  639. mapping:
  640. field:
  641. type: string
  642. label: 'Field'
  643. rendered:
  644. type: boolean
  645. label: 'Use rendered output to group rows'
  646. rendered_strip:
  647. type: boolean
  648. label: 'Remove tags from rendered output'
  649. row_class:
  650. type: string
  651. label: 'Row class'
  652. default_row_class:
  653. type: boolean
  654. label: 'Add views row classes'
  655. uses_fields:
  656. type: boolean
  657. label: 'Force using fields'
  658. views_filter:
  659. type: views_handler
  660. mapping:
  661. operator:
  662. type: string
  663. label: 'Operator'
  664. value:
  665. type: views.filter_value.[%parent.plugin_id]
  666. label: 'Value'
  667. group:
  668. type: integer
  669. label: 'Group'
  670. exposed:
  671. type: boolean
  672. label: 'Expose this filter to visitors, to allow them to change it'
  673. expose:
  674. type: mapping
  675. label: 'Expose'
  676. mapping:
  677. operator_id:
  678. type: string
  679. label: 'Operator identifier'
  680. label:
  681. type: label
  682. label: 'Label'
  683. description:
  684. type: label
  685. label: 'Description'
  686. use_operator:
  687. type: boolean
  688. label: 'Expose operator'
  689. operator:
  690. type: string
  691. label: 'Operator'
  692. operator_limit_selection:
  693. type: boolean
  694. label: 'Limit the available operators'
  695. operator_list:
  696. type: sequence
  697. label: 'List of available operators'
  698. sequence:
  699. type: string
  700. label: 'Operator'
  701. identifier:
  702. type: string
  703. label: 'Filter identifier'
  704. required:
  705. type: boolean
  706. label: 'Required'
  707. remember:
  708. type: boolean
  709. label: 'Remember the last selection'
  710. multiple:
  711. type: boolean
  712. label: 'Allow multiple selections'
  713. remember_roles:
  714. type: sequence
  715. label: 'User roles'
  716. sequence:
  717. type: string
  718. label: 'Role'
  719. is_grouped:
  720. type: boolean
  721. label: 'Grouped filters'
  722. group_info:
  723. type: mapping
  724. label: 'Group'
  725. mapping:
  726. label:
  727. type: label
  728. label: 'Label'
  729. description:
  730. type: label
  731. label: 'Description'
  732. identifier:
  733. type: string
  734. label: 'Identifier'
  735. optional:
  736. type: boolean
  737. label: 'Optional'
  738. widget:
  739. type: string
  740. label: 'Widget type'
  741. multiple:
  742. type: boolean
  743. label: 'Allow multiple selections'
  744. remember:
  745. type: boolean
  746. label: 'Remember'
  747. default_group:
  748. type: string
  749. label: 'Default'
  750. default_group_multiple:
  751. type: sequence
  752. label: 'Defaults'
  753. sequence:
  754. type: integer
  755. label: 'Default'
  756. group_items:
  757. type: sequence
  758. label: 'Group items'
  759. sequence:
  760. type: views.filter.group_item.[%parent.%parent.%parent.plugin_id]
  761. label: 'Group item'
  762. plugin_id:
  763. type: string
  764. label: 'Plugin ID'
  765. views_filter_group_item:
  766. type: mapping
  767. label: 'Group item'
  768. mapping:
  769. title:
  770. type: label
  771. label: 'Label'
  772. operator:
  773. type: string
  774. label: 'Operator'
  775. value:
  776. type: views.filter_value.[%parent.%parent.%parent.%parent.plugin_id]
  777. label: 'Value'
  778. views_relationship:
  779. type: views_handler
  780. mapping:
  781. admin_label:
  782. type: string
  783. label: 'Administrative title'
  784. required:
  785. type: boolean
  786. label: 'Require this relationship'
  787. views_query:
  788. type: mapping
  789. label: 'Query options'
  790. views_row:
  791. type: mapping
  792. label: 'Row options'
  793. mapping:
  794. relationship:
  795. type: string
  796. label: 'Relationship'
  797. views_entity_row:
  798. type: views_row
  799. mapping:
  800. view_mode:
  801. type: string
  802. label: 'View mode'
  803. views_cache:
  804. type: mapping
  805. label: 'Cache configuration'
  806. mapping:
  807. type:
  808. type: string
  809. label: 'Cache type'
  810. views_display_extender:
  811. type: mapping
  812. label: 'Display extender settings'
  813. views_field_bulk_form:
  814. type: views_field
  815. label: 'Bulk operation'
  816. mapping:
  817. action_title:
  818. type: label
  819. label: 'Action title'
  820. include_exclude:
  821. type: string
  822. label: 'Available actions'
  823. selected_actions:
  824. type: sequence
  825. label: 'Available actions'
  826. sequence:
  827. type: string
  828. label: 'Action'

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.