Piwik \ ViewDataTable \
的基本显示属性ViewDataTable年代。
客户端属性是应该传递给浏览器的属性,以便客户端JavaScript可以使用它们。只影响输出HTML的ViewDataTables。
可覆盖属性是可以通过查询字符串设置的属性。如果请求具有与可覆盖属性匹配的查询参数,则该属性将被设置为查询参数值。
重用基本属性
类中的许多属性仅对可视化类,但可为扩展的其他可视化设置ViewDataTable直接。
扩展的可视化ViewDataTable如果想直接重用这些属性,则必须确保这些属性的使用方式与它们在其中的使用方式完全相同可视化.
定义新的显示属性
如果您正在创建自己的可视化,并希望为其添加新的显示属性,请扩展该类并将属性添加为字段。
属性被标记为客户端属性addPropertiesThatShouldBeAvailableClientSide ()方法。
属性被标记为可重写addPropertiesThatCanBeOverwrittenByQueryParams ()方法。
定义新的显示属性
类MyCustomVizConfig扩展Config{/** *我的自定义属性。它是可覆盖的。*\/ public $my_custom_property = false;/** *另一个自定义属性。它可以在客户端使用。*\/ public $another_custom_property = true;公共函数__construct() {parent::__construct();$ this - > addPropertiesThatShouldBeAvailableClientSide(数组(' another_custom_property '));$ this - > addPropertiesThatCanBeOverwrittenByQueryParams(数组(' my_custom_property '));}}
这个类定义了以下属性:
clientSideProperties美元
-“客户端属性”的ViewDataTable属性列表。overridableProperties美元
-可以被查询参数覆盖的ViewDataTable属性列表。footer_icons美元
-控制在数据表视图的左下角显示什么页脚图标。show_visualization_only美元
-控制按钮和UI控件是否围绕可视化或显示或仅显示可视化。show_goals美元
-控制是否显示目标页脚图标。show_insights美元
-控制是否显示“insights”页脚图标。美元的翻译
-数组属性映射DataTable列名与其国际化名称。show_exclude_low_population美元
-控制是否显示“排除低人口”选项(在点击“齿轮”图标后显示的弹出窗口中可见)。show_flatten_table美元
-是否显示“Flatten”选项(在点击“齿轮”图标后显示的弹出窗口中可见)。show_pivot_by_subtable美元
-是否显示“Pivot by subtable”选项(在单击“齿轮”图标后显示的弹出窗口中可见)。pivot_by_dimension美元
-当单击“pivot by subtable”选项时,要pivot的维度ID。pivot_by_column美元
-在数据透视表中显示的列。pivot_dimension_name美元
-人类可读的枢轴维度名称。show_table美元
-控制是否显示允许用户切换到“正常”数据表视图的页脚图标。show_table_all_columns美元
-控制是否显示“所有列”页脚图标。show_table_performance美元
-控制是否显示“性能列”页脚图标(如果可用)。show_footer美元
—控制是否显示整个视图页脚。show_footer_icons美元
-控制是否显示包含所有页脚图标和限制选择器的行。columns_to_display美元
-数组属性,该属性决定将显示哪些列。show_all_views_icons美元
-控制是否显示图形和非核心viewDataTable页脚图标。related_reports美元
-相关报告在数据表视图下列出。related_reports_title美元
灰;在列出相关报告前默认显示“相关报告”,字符串可更改。美元的标题
—报告标题。title_edit_entity_url美元
—如果设置了URL,则报表标题为可点击。美元的描述
—报表描述。show_related_reports美元
—控制报表的相关报表是否显示在视图中。美元的文档
—包含报表的相关文档。onlineGuideUrl美元
-该报告的在线指南(或插件)的URL链接。custom_parameters美元
-数组属性包含要保存在JSON数据表div的data-params HTML属性中的自定义数据。show_limit_control美元
-控制是否总是显示限制下拉菜单(允许用户更改显示的数据数量)。show_search美元
-控制是否显示数据表下的搜索框。show_periods美元
-控制是否显示数据表下的周期选择器。selectable_periods美元
-控制在启用周期选择器时可以选择哪些周期show_export美元
-控制是否显示数据表下的导出特性。enable_sort美元
-控制用户是否可以通过单击表列标题对数据表进行排序。show_bar_chart美元
—控制是否显示允许用户以柱状图方式查看数据的页脚图标。show_pie_chart美元
—控制是否显示允许用户以饼图方式查看数据的页脚图标。show_tag_cloud美元
—控制是否显示允许用户作为标签云查看数据的页脚图标。show_as_content_block美元
—如果启用,将可视化显示为内容块。show_title美元
—“启用”显示报表的标题。show_export_as_rss_feed美元
-控制是否允许用户将数据导出为RSS提要。show_ecommerce美元
-控制是否显示“电子商务订单”/“废弃购物车”页脚图标。show_header_message美元
-存储一个HTML消息(如果有的话)显示在数据表视图之上。show_footer_message美元
-存储一个HTML消息(如果有的话)显示在数据表视图下。metrics_documentation美元
-数组属性,用于存储单个指标的文档。tooltip_metadata_name美元
—行元数据名称,包含指定行的工具提示。self_url美元
-视图显示的报表的URL。datatable_css_class美元
- CSS类使用在输出HTML div。datatable_js_type美元
—获取结果HTML后实例化的JavaScript类。search_recursive美元
-如果为真,搜索DataTable将搜索所有子表。y_axis_unit美元
—显示列的单位。show_export_as_image_icon美元
-控制是否显示“导出为图像”页脚图标。美元的过滤器
-在显示数据表之前应该运行的数据表过滤器数组。subtable_controller_action美元
-包含在请求当前报表的子表时调用的控制器动作。show_pagination_control美元
-控制“前一页”/“下一页”链接是否显示在数据表页脚中。show_offset_information美元
-控制偏移量信息(例如,'5-10 of 20')是否显示在数据表下。hide_annotations_view美元
-控制是否显示注释。disable_all_rows_filter_limit美元
-控制限制选择器是否显示“全部”行限制选项。max_export_filter_limit美元
—设置可导出的最大行数限制。no_data_message美元
-消息显示是否没有数据可供报告默认为CoreHome_ThereIsNoDataForThisReport
如果没有设置datatable_actions美元
-在数据表页脚显示为图标的额外操作列表。segmented_visitor_log_segment_suffix美元
disable_comparison美元
-禁用ViewDataTable的这种特定用法的比较支持。report_id美元
controllerName美元
controllerAction美元
clientSideProperties美元
“客户端属性”的ViewDataTable属性列表。
overridableProperties美元
可以被查询参数覆盖的ViewDataTable属性列表。
footer_icons美元
控制在数据表视图的左下角显示哪些页脚图标。
此属性的值必须是页脚图标组的数组。页脚图标组有一组属性,包括描述页脚图标的数组。例如:
array(array(//页脚图标组1 'class' => 'footerIconGroup1CssClass', 'buttons' => array('id' => 'myid', 'title' => 'My Tooltip', 'icon' => 'path/to/ My /icon.png')), array(//页脚图标组2 'class' => 'footerIconGroup2CssClass', 'buttons' => array(…)))
默认情况下,当用户单击页脚图标时,Matomo(以前的Piwik)将假设'id'是一个viewDataTable id,并尝试重新加载数据表w/新的viewDataTable。您可以通过DataTable添加适当的处理程序来提供自己的页脚图标行为。在JavaScript代码中使用registerFooterIconHandler。
这个属性的默认值没有在这里设置,它将显示“Normal Table”图标、“All Columns”图标、“Goals Columns”图标和所有jqPlot图形列,除非其他属性告诉视图排除它们。
show_visualization_only美元
控制是否在可视化周围显示按钮和UI控件,或者仅显示可视化。
show_goals美元
控制是否显示目标页脚图标。
show_insights美元
控制是否显示“insights”页脚图标。
美元的翻译
将DataTable列名与其国际化名称映射的数组属性。
此属性的默认值在其他地方设置。它将包含通用度量的翻译。
show_exclude_low_population美元
控制是否显示“排除低人口”选项(在单击“齿轮”图标后显示的弹出框中可见)。
show_flatten_table美元
是否显示“Flatten”选项(在单击“cog”图标后显示的弹出窗口中可见)。
show_pivot_by_subtable美元
是否显示“Pivot by subtable”选项(在单击“cog”图标后显示的弹出窗口中可见)。
pivot_by_dimension美元
单击“以子表作为枢轴”选项时要枢轴的维度的ID。默认为要显示的报表的子表维度。
pivot_by_column美元
要在数据透视表中显示的列。如果未指定,默认为第一个非标签列。
pivot_dimension_name美元
人类可读的主维名称。
show_table美元
控制是否显示允许用户切换到“正常”数据表视图的页脚图标。
show_table_all_columns美元
控制是否显示“所有列”页脚图标。
show_table_performance美元
控制是否显示“性能列”页脚图标(如果可用)。
show_footer美元
控制是否显示整个视图页脚。
show_footer_icons美元
控制是否显示包含所有页脚图标和限制选择器的行。
columns_to_display美元
数组属性,该属性决定将显示哪些列。不在这个数组中的列不应该出现在ViewDataTable可视化中。
例子:数组('label', ' nb_visitors ', 'nb_uniq_visitors')
如果此值为空,则默认为阵列(“标签”,“nb_visits”)
或阵列(“标签”,“nb_uniq_visitors”)
加载数据后,如果报告中包含nb_uniq_visitors列。
show_all_views_icons美元
控制是否显示图形和非核心viewDataTable页脚图标。
related_reports美元
相关报告列在数据表视图下面。单击时,原始报告将更改为所单击的报告,列表也将更改,以便可以导航回原始报告。
related_reports_title美元
在列出相关报告前默认显示“相关报告”,字符串可更改。
美元的标题
报告标题。与相关报表一起使用,因此在切换报表时可以更改报表标题。
如果添加相关报表,则必须设置此参数。
title_edit_entity_url美元
如果设置了URL,则报告的标题将是可单击的。应该为可以配置(编辑)的实体设置,例如goal。例如,当有一个目标报告,并且允许某人编辑目标实体时,应该有一个指向编辑目标表单的URL链接。
字符串
价值。美元的描述
报告描述。如目标描述
show_related_reports美元
控制报表的相关报表是否与视图一起列出。
美元的文档
包含报表的文档。
onlineGuideUrl美元
链接到该报告的在线指南(或插件)的URL。
字符串
价值。custom_parameters美元
数组属性,包含要以JSON格式保存在数据表div的data-params HTML属性中的自定义数据。这些数据可以被JavaScript DataTable类使用。
例如:array('typeReferrer' =>…)
然后可以通过clientSideParameters.typeReferrer在分支模板中访问它
show_limit_control美元
控制是否始终显示限制下拉菜单(允许用户更改显示的数据数量)。
通常只在分页启用时显示。
show_search美元
控制是否显示数据表下的搜索框。
show_periods美元
控制是否显示数据表下的周期选择器。
selectable_periods美元
控制在启用周期选择器时可以选择哪些周期
show_export美元
控制是否显示数据表下的导出特性。
enable_sort美元
控制用户是否可以通过单击表列标题对数据表进行排序。
show_bar_chart美元
控制是否显示允许用户以柱状图形式查看数据的页脚图标。
show_pie_chart美元
控制是否显示允许用户以饼图形式查看数据的页脚图标。
show_tag_cloud美元
控制是否显示允许用户作为标记云查看数据的页脚图标。
show_as_content_block美元
如果启用,将可视化显示为内容块。这类似于用< ContentBlock / >
保龄球
价值。show_title美元
如果启用,显示报告的标题。
保龄球
价值。show_export_as_rss_feed美元
控制是否允许用户将数据导出为RSS提要。
show_ecommerce美元
控制是否显示“电子商务订单”/“废弃购物车”页脚图标。
show_header_message美元
存储要显示在数据表视图上方的HTML消息(如果有的话)。
注意:信息将以原稿打印。别忘了在需要的地方逃跑!
show_footer_message美元
存储要在数据表视图下显示的HTML消息(如果有的话)。
注意:信息将以原稿打印。别忘了在需要的地方逃跑!
metrics_documentation美元
数组属性,用于存储单个指标的文档。
如。数组(' nb_visitors ' => '…”,……)
默认情况下,它被设置为从报表元数据中检索的值(通过API)。getReportMetadata API方法)。
tooltip_metadata_name美元
包含特定行的工具提示的行元数据名称。
self_url美元
视图显示的报表的URL。修改这意味着从“相关报告”中单击返回该报告将转到不同的URL。当返回原始报表时,可用于加载整个页面,而不是单个报表。
用于请求不带通用过滤器的报表的URL。
datatable_css_class美元
在输出HTML div中使用的CSS类。这是在可视化CSS类之外添加的。
datatable_js_type美元
在获得结果HTML之后实例化的JavaScript类。这个类处理DataTable视图的所有交互行为。
search_recursive美元
如果为真,则搜索DataTable将搜索所有子表。
y_axis_unit美元
显示列的单位。如果只显示一个非标签列,则有效。
show_export_as_image_icon美元
控制是否显示“导出为图像”页脚图标。
美元的过滤器
在显示数据表之前应该运行的数据表过滤器数组。该数组的元素可以是一个闭包,也可以是一个最多包含三个元素的数组,包括:—过滤器名称(或闭包)—过滤器参数数组—一个布尔值,表示过滤器是否是优先级过滤器
优先级筛选器在队列筛选器之前运行。这些过滤器应该是添加/删除行的过滤器。
如果使用闭包,则将视图作为参数追加。
subtable_controller_action美元
包含在请求当前报表的子表时要调用的控制器动作。
默认情况下,这被设置为用于请求报告的控制器动作。
show_pagination_control美元
控制“前一页”/“下一页”链接是否显示在数据表页脚中。这些链接改变了'filter_offset'查询参数,从而允许分页。
show_offset_information美元
控制偏移量信息(例如,'5-10 of 20')是否显示在数据表下。
hide_annotations_view美元
控制是否显示注释。
disable_all_rows_filter_limit美元
控制是否为限制选择器显示“全部”行限制选项。
保龄球
价值。max_export_filter_limit美元
设置可以导出的最大行数的限制。
int
价值。no_data_message美元
显示报表默认为是否没有数据的消息CoreHome_ThereIsNoDataForThisReport
如果没有设置
注意:信息将以原稿打印。别忘了在需要的地方逃跑!
字符串
价值。datatable_actions美元
在数据表页脚中显示为图标的额外操作列表。
还不是API。
数组
价值。segmented_visitor_log_segment_suffix美元
disable_comparison美元
禁用ViewDataTable这种特定用法的比较支持。
保龄球
价值。report_id美元
controllerName美元
controllerAction美元
该类定义了以下方法:
__construct ()
——构造函数。addPropertiesThatShouldBeAvailableClientSide ()
—标记将属性显示为客户端属性。addPropertiesThatCanBeOverwrittenByQueryParams ()
-标记显示属性为可重写。getproperty ()
-返回该配置对象中所有属性值的数组。removeColumnToDisplay ()
getPriorityFilters ()
getPresentationFilters ()
addRelatedReport ()
灰;控件中添加相关报表related_reports美元财产。addRelatedReports ()
灰;属性中添加几个相关报告related_reports美元财产。addTranslation ()
-将国际化文本与度量关联。addTranslations ()
-将多个翻译与度量相关联。disablePivotBySubtableIfTableHasNoSubtables ()
__construct ()
构造函数。
addPropertiesThatShouldBeAvailableClientSide ()
标记将属性显示为客户端属性。读到这了解更多。
propertyNames美元
(数组
) -物业名称一览表,例如:阵列(“show_limit_control”、“show_goals”)
.addPropertiesThatCanBeOverwrittenByQueryParams ()
标记将属性显示为可重写。读到这了解更多。
propertyNames美元
(数组
) -物业名称一览表,例如:阵列(“show_limit_control”、“show_goals”)
.getproperty ()
返回此配置对象中所有属性值的数组。属性值按名称映射。
数组
,例如,阵列(show_limit_control = > 0, ' show_goals ' = > 1,…)
removeColumnToDisplay ()
它接受以下参数:
columnToRemove美元
它不返回任何东西,也不返回混合结果。
getPriorityFilters ()
getPresentationFilters ()
addRelatedReport ()
控件中添加相关报表related_reports美元财产。如果报表引用了当前显示的报表,则不会将其添加到相关报表列表中。
relatedReport美元
(字符串
) -报告的插件和方法,例如:“DevicesDetection.getBrowsers”
.美元的标题
(字符串
) -报告的显示名称,例如,“浏览器”
.queryParams美元
(数组
) -任何需要在相关报告的URL中设置的额外查询参数,例如:array('idGoal' => ' ecommermerorder ')
.addRelatedReports ()
属性中添加几个相关报告related_reports美元财产。如果任何报表引用了当前显示的报表,则不会将其添加到列表中。不过,所有其他报告仍将被添加。
如果需要确保相关的报表URL具有一些额外的查询参数,请使用addRelatedReport ().
relatedReports美元
(数组
) -数组映射报告id及其国际化的显示标题,例如,(“DevicesDetection数组。getBrowsers' => '浏览器','分辨率。getConfiguration' => '配置')
addTranslation ()
将国际化文本与度量相关联。覆盖现有映射。
看到美元的翻译.
columnName美元
(字符串
) -报表数据中的列名称,例如,“nb_visits”
或“goal_1_nb_conversions”
.美元的翻译
(字符串
) -国际化文本,例如,“访问”
或《我的目标》的转化率
.addTranslations ()
将多个翻译与度量相关联。
美元的翻译
(数组
) -列名=>文本映射的数组,例如,数组(' nb_visitors ' => ' visitors ', 'goal_1_nb_conversions' => ' 'My Goal' ')
disablePivotBySubtableIfTableHasNoSubtables ()
它接受以下参数:
美元的表
(数据表
) - - -它不返回任何东西,也不返回混合结果。