• Home
• Piwik
• ViewDataTable
• Config

PHP Class Piwik\ViewDataTable\Config

**Client Side Properties** Client side properties are properties that should be passed on to the browser so client side JavaScript can use them. Only affects ViewDataTables that output HTML. **Overridable Properties** Overridable properties are properties that can be set via the query string. If a request has a query parameter that matches an overridable property, the property will be set to the query parameter value. **Reusing base properties** Many of the properties in this class only have meaning for the {@link Piwik\Plugin\Visualization} class, but can be set for other visualizations that extend {@link Piwik\Plugin\ViewDataTable} directly. Visualizations that extend {@link Piwik\Plugin\ViewDataTable} directly and want to re-use these properties must make sure the properties are used in the exact same way they are used in {@link Piwik\Plugin\Visualization}. **Defining new display properties** If you are creating your own visualization and want to add new display properties for it, extend this class and add your properties as fields. Properties are marked as client side properties by calling the {@link addPropertiesThatShouldBeAvailableClientSide()} method. Properties are marked as overridable by calling the {@link addPropertiesThatCanBeOverwrittenByQueryParams()} method. ### Example **Defining new display properties** class MyCustomVizConfig extends Config { ** * My custom property. It is overridable. *\/ public $my_custom_property = false; ** * Another custom property. It is available client side. *\/ public $another_custom_property = true; public function __construct() { parent::__construct(); $this->addPropertiesThatShouldBeAvailableClientSide(array('another_custom_property')); $this->addPropertiesThatCanBeOverwrittenByQueryParams(array('my_custom_property')); } } Datei anzeigen Open project: piwik/piwik Class Usage Examples

Public Properties

Property	Type	Description
$clientSideProperties		The list of ViewDataTable properties that are 'Client Side Properties'.
$columns_to_display		Example: array('label', 'nb_visits', 'nb_uniq_visitors') If this value is empty it will be defaulted to array('label', 'nb_visits') or array('label', 'nb_uniq_visitors') if the report contains a nb_uniq_visitors column after data is loaded.
$controllerAction
$controllerName
$custom_parameters		e.g. array('typeReferrer' => ...) It can then be accessed in the twig templates by clientSideParameters.typeReferrer
$datatable_css_class		CSS class to use in the output HTML div. This is added in addition to the visualization CSS class.
$datatable_js_type		The JavaScript class to instantiate after the result HTML is obtained. This class handles all interactive behavior for the DataTable view.
$description		The report description. eg like a goal description
$documentation		Contains the documentation for a report.
$enable_sort		Controls whether the user can sort DataTables by clicking on table column headings.
$export_limit		Defaulted to the value of the [General] API_datatable_default_limit INI config option.
$filters		Priority filters are run before queued filters. These filters should be filters that add/delete rows. If a closure is used, the view is appended as a parameter.
$footer_icons		The value of this property must be an array of footer icon groups. Footer icon groups have set of properties, including an array of arrays describing footer icons. For example: array( array( // footer icon group 1 'class' => 'footerIconGroup1CssClass', 'buttons' => array( 'id' => 'myid', 'title' => 'My Tooltip', 'icon' => 'path/to/my/icon.png' ) ), array( // footer icon group 2 'class' => 'footerIconGroup2CssClass', 'buttons' => array(...) ) ) By default, when a user clicks on a footer icon, Piwik will assume the 'id' is a viewDataTable ID and try to reload the DataTable w/ the new viewDataTable. You can provide your own footer icon behavior by adding an appropriate handler via DataTable.registerFooterIconHandler in your JavaScript code. The default value of this property is not set here and will show the 'Normal Table' icon, the 'All Columns' icon, the 'Goals Columns' icon and all jqPlot graph columns, unless other properties tell the view to exclude them.
$hide_annotations_view		Controls whether annotations are shown or not.
$metrics_documentation		E.g. array('nb_visits' => '...', ...) By default this is set to values retrieved from report metadata (via API.getReportMetadata API method).
$overridableProperties		The list of ViewDataTable properties that can be overriden by query parameters.
$pivot_by_column		The column to display in pivot tables. Defaults to the first non-label column if not specified.
$pivot_by_dimension		The ID of the dimension to pivot by when the 'pivot by subtable' option is clicked. Defaults to the subtable dimension of the report being displayed.
$pivot_dimension_name		The human readable name of the pivot dimension.
$related_reports		Related reports are listed below a datatable view. When clicked, the original report will change to the clicked report and the list will change so the original report can be navigated back to.
$related_reports_title		"Related Reports" is displayed by default before listing the Related reports, The string can be changed.
$report_id
$search_recursive		If true, searching through the DataTable will search through all subtables.
$self_url		The URL used to request the report without generic filters.
$show_all_views_icons		Controls whether graph and non core viewDataTable footer icons are shown or not.
$show_as_content_block	boolean	If enabled, shows the visualization as a content block. This is similar to wrapping your visualization with a
$show_bar_chart		Controls whether the footer icon that allows users to view data as a bar chart is shown.
$show_ecommerce		Controls whether the 'Ecoommerce Orders'/'Abandoned Cart' footer icons are shown or not.
$show_exclude_low_population		Controls whether the 'Exclude Low Population' option (visible in the popup that displays after clicking the 'cog' icon) is shown.
$show_export_as_image_icon		Controls whether to show the 'Export as Image' footer icon.
$show_export_as_rss_feed		Controls whether the user is allowed to export data as an RSS feed or not.
$show_flatten_table		Whether to show the 'Flatten' option (visible in the popup that displays after clicking the 'cog' icon).
$show_footer		Controls whether the entire view footer is shown.
$show_footer_icons		Controls whether the row that contains all footer icons & the limit selector is shown.
$show_footer_message		Stores an HTML message (if any) to display under the datatable view.
$show_goals		Controls whether the goals footer icon is shown.
$show_insights		Controls whether the 'insights' footer icon is shown.
$show_limit_control		Normally shown only if pagination is enabled.
$show_offset_information		Controls whether offset information (ie, '5-10 of 20') is shown under the datatable.
$show_pagination_control		Controls whether the 'prev'/'next' links are shown in the DataTable footer. These links change the 'filter_offset' query parameter, thus allowing pagination.
$show_pie_chart		Controls whether the footer icon that allows users to view data as a pie chart is shown.
$show_pivot_by_subtable		Whether to show the 'Pivot by subtable' option (visible in the popup that displays after clicking the 'cog' icon).
$show_related_reports		Controls whether a report's related reports are listed with the view or not.
$show_search		Controls whether the search box under the datatable is shown.
$show_table		Controls whether the footer icon that allows users to switch to the 'normal' DataTable view is shown.
$show_table_all_columns		Controls whether the 'All Columns' footer icon is shown.
$show_tag_cloud		Controls whether the footer icon that allows users to view data as a tag cloud is shown.
$show_title	boolean	If enabled shows the title of the report.
$show_visualization_only		Controls whether the buttons and UI controls around the visualization or shown or if just the visualization alone is shown.
$subtable_controller_action		By default, this is set to the controller action used to request the report.
$title		This must be set if related reports are added.
$title_edit_entity_url	string	If a URL is set, the title of the report will be clickable. Is supposed to be set for entities that can be configured (edited) such as goal. Eg when there is a goal report, and someone is allowed to edit the goal entity, a link is supposed to be with a URL to the edit goal form.
$tooltip_metadata_name		Row metadata name that contains the tooltip for the specific row.
$translations		The default value for this property is set elsewhere. It will contain translations of common metrics.
$y_axis_unit		The unit of the displayed column. Valid if only one non-label column is displayed.

Public Methods

Method	Description
__construct ( )	Constructor.
addPropertiesThatCanBeOverwrittenByQueryParams ( array $propertyNames )	Marks display properties as overridable. Read this to learn more.
addPropertiesThatShouldBeAvailableClientSide ( array $propertyNames )	Marks display properties as client side properties. Read this to learn more.
addRelatedReport ( string $relatedReport, string $title, array $queryParams = [] )	Adds a related report to the {@link $related_reports} property. If the report references the one that is currently being displayed, it will not be added to the related report list.
addRelatedReports ( array $relatedReports )	Adds several related reports to the {@link $related_reports} property. If any of the reports references the report that is currently being displayed, it will not be added to the list. All other reports will still be added though.
addTranslation ( string $columnName, string $translation )	Associates internationalized text with a metric. Overwrites existing mappings.
addTranslations ( array $translations )	Associates multiple translations with metrics.
disablePivotBySubtableIfTableHasNoSubtables ( DataTable $table )
getPresentationFilters ( )
getPriorityFilters ( )
getProperties ( ) : array	Returns array of all property values in this config object. Property values are mapped by name.
removeColumnToDisplay ( $columnToRemove )
setController ( $controllerName, $controllerAction )
setDefaultColumnsToDisplay ( $columns, $hasNbVisits, $hasNbUniqVisitors )

Private Methods

Method	Description
getFiltersToRun ( )
loadDocumentation ( )	Load documentation from the API
setShouldShowPivotBySubtable ( )

Method Details

Property Details