diff options
author | Benaka Moorthi <benaka.moorthi@gmail.com> | 2013-09-19 00:14:49 +0400 |
---|---|---|
committer | Benaka Moorthi <benaka.moorthi@gmail.com> | 2013-09-19 00:14:49 +0400 |
commit | e4c5269efa8bdd9976b87327f067b09b535b032f (patch) | |
tree | 53800a54803c2140450ca86fcd977b4acb8550a9 /plugins/CoreVisualizations | |
parent | 604210375d71655e59767aab4f66e5645b3c7f8e (diff) |
Refs #4041, add default value to all visualization property docs.
Diffstat (limited to 'plugins/CoreVisualizations')
4 files changed, 29 insertions, 1 deletions
diff --git a/plugins/CoreVisualizations/Visualizations/Cloud.php b/plugins/CoreVisualizations/Visualizations/Cloud.php index 37cd117b5d..6b016c38c5 100644 --- a/plugins/CoreVisualizations/Visualizations/Cloud.php +++ b/plugins/CoreVisualizations/Visualizations/Cloud.php @@ -31,6 +31,8 @@ class Cloud extends DataTableVisualization /** * Whether to display the logo assocatied with a DataTable row (stored as 'logo' row metadata) * instead of the label in Tag Clouds. + * + * Default value: false */ const DISPLAY_LOGO_INSTEAD_OF_LABEL = 'display_logo_instead_of_label'; diff --git a/plugins/CoreVisualizations/Visualizations/HtmlTable.php b/plugins/CoreVisualizations/Visualizations/HtmlTable.php index 03120461ed..2b98761d8a 100644 --- a/plugins/CoreVisualizations/Visualizations/HtmlTable.php +++ b/plugins/CoreVisualizations/Visualizations/HtmlTable.php @@ -42,12 +42,16 @@ class HtmlTable extends DataTableVisualization /** * Controls whether the entire DataTable should be rendered (including subtables) or just one * specific table in the tree. + * + * Default value: false */ const SHOW_EXPANDED = 'show_expanded'; /** * When showing an expanded datatable, this property controls whether rows with subtables are * replaced with their subtables, or if they are shown alongside their subtables. + * + * Default value: false */ const REPLACE_ROW_WITH_SUBTABLE = 'replace_row_with_subtable'; @@ -55,6 +59,8 @@ class HtmlTable extends DataTableVisualization * Controls whether any DataTable Row Action icons are shown. If true, no icons are shown. * * @see also self::DISABLE_ROW_EVOLUTION + * + * Default value: false */ const DISABLE_ROW_ACTIONS = 'disable_row_actions'; @@ -62,6 +68,8 @@ class HtmlTable extends DataTableVisualization * Controls whether the row evolution DataTable Row Action icon is shown or not. * * @see also self::DISABLE_ROW_ACTIONS + * + * Default value: false */ const DISABLE_ROW_EVOLUTION = 'disable_row_evolution'; @@ -69,12 +77,16 @@ class HtmlTable extends DataTableVisualization * If true, the 'label', 'nb_visits', 'nb_uniq_visitors' (if present), 'nb_actions', * 'nb_actions_per_visit', 'avg_time_on_site', 'bounce_rate' and 'conversion_rate' (if * goals view is not allowed) are displayed. + * + * Default value: false */ const SHOW_EXTRA_COLUMNS = 'show_extra_columns'; /** * If true, conversions for each existing goal will be displayed for the visits in * each row. + * + * Default value: false */ const SHOW_GOALS_COLUMNS = 'show_goals_columns'; @@ -83,6 +95,8 @@ class HtmlTable extends DataTableVisualization * 'show_goals_columns' property is also true. * * @see also self::SHOW_GOALS_COLUMNS + * + * Default value: false */ const DISABLE_SUBTABLE_IN_GOALS_VIEW = 'disable_subtable_when_show_goals'; @@ -90,6 +104,8 @@ class HtmlTable extends DataTableVisualization * Controls whether the summary row is displayed on every page of the datatable view or not. * If false, the summary row will be treated as the last row of the dataset and will only visible * when viewing the last rows. + * + * Default value: false */ const KEEP_SUMMARY_ROW = 'keep_summary_row'; @@ -97,6 +113,8 @@ class HtmlTable extends DataTableVisualization * If true, the summary row will be colored differently than all other DataTable rows. * * @see also self::KEEP_SUMMARY_ROW + * + * Default value: false */ const HIGHLIGHT_SUMMARY_ROW = 'highlight_summary_row'; diff --git a/plugins/CoreVisualizations/Visualizations/JqplotGraph.php b/plugins/CoreVisualizations/Visualizations/JqplotGraph.php index 11e1e40300..95cbf7610e 100644 --- a/plugins/CoreVisualizations/Visualizations/JqplotGraph.php +++ b/plugins/CoreVisualizations/Visualizations/JqplotGraph.php @@ -29,6 +29,8 @@ class JqplotGraph extends Graph * must be a subclass of JQPlotExternalSeriesToggle. * * @see self::EXTERNAL_SERIES_TOGGLE_SHOW_ALL + * + * Default value: false */ const EXTERNAL_SERIES_TOGGLE = 'external_series_toggle'; @@ -36,11 +38,15 @@ class JqplotGraph extends Graph * Whether the graph should show all loaded series upon initial display. * * @see self::EXTERNAL_SERIES_TOGGLE + * + * Default value: false */ const EXTERNAL_SERIES_TOGGLE_SHOW_ALL = 'external_series_toggle_show_all'; /** - * The number of x-axis ticks between x-axis labels. + * The number of x-axis ticks for each x-axis label. + * + * Default: 2 */ const X_AXIS_STEP_SIZE = 'x_axis_step_size'; diff --git a/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php b/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php index 40892f09c0..7e8237a6a3 100644 --- a/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php +++ b/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php @@ -28,6 +28,8 @@ class Evolution extends JqplotGraph /** * Whether to show a line graph or a bar graph. + * + * Default value: true */ const SHOW_LINE_GRAPH = 'show_line_graph'; |