3 namespace Drupal\views\Annotation;
6 * Defines a Plugin annotation object for views display plugins.
8 * @see \Drupal\views\Plugin\views\display\DisplayPluginBase
10 * @ingroup views_display_plugins
14 class ViewsDisplay extends ViewsPluginAnnotationBase {
24 * The plugin title used in the views UI.
26 * @var \Drupal\Core\Annotation\Translation
28 * @ingroup plugin_translatable
33 * (optional) The short title used in the views UI.
35 * @var \Drupal\Core\Annotation\Translation
37 * @ingroup plugin_translatable
39 public $short_title = '';
42 * The administrative name of the display.
44 * The name is displayed on the Views overview and also used as default name
47 * @var \Drupal\Core\Annotation\Translation
49 * @ingroup plugin_translatable
54 * A short help string; this is displayed in the views UI.
56 * @var \Drupal\Core\Annotation\Translation
58 * @ingroup plugin_translatable
63 * Whether or not to use hook_menu() to register a route.
67 public $uses_menu_links;
70 * Does the display plugin registers routes to the route.
77 * Does the display plugin provide blocks.
81 public $uses_hook_block;
84 * A list of places where contextual links should be added.
93 * If you don't specify it there will be contextual links rendered for all
94 * displays of a view. If this is not set or regions have been specified,
95 * views will display an option to 'hide contextual links'. Use an empty
100 public $contextual_links_locations;
103 * The base tables on which this display plugin can be used.
105 * If no base table is specified the plugin can be used with all tables.
112 * The theme function used to render the display's output.
119 * Whether the plugin should be not selectable in the UI.
121 * If it's set to TRUE, you can still use it via the API in config files.
128 * Whether the display returns a response object.
132 public $returns_response;