Add parameters for enabling/disabling labels & legends on charts

Author: mdmintz

seleniumbase/fixtures/base_case.py

@@ -4086,20 +4086,23 @@ def begin_presentation(
 
     def create_pie_chart(
             self, chart_name=None, title=None, subtitle=None,
-            data_name=None, unit=None, libs=True):
+            data_name=None, unit=None, libs=True, labels=True, legend=True):
         """ Creates a JavaScript pie chart using "HighCharts".
             @Params
             chart_name - If creating multiple charts,
                          use this to select which one.
             title - The title displayed for the chart.
             subtitle - The subtitle displayed for the chart.
-            data_name - Set the series name. Useful for multi-series charts.
+            data_name - The series name. Useful for multi-series charts.
+                        If no data_name, will default to using "Series 1".
             unit - The description label given to the chart's y-axis values.
             libs - The option to include Chart libraries (JS and CSS files).
                    Should be set to True (default) for the first time creating
                    a chart on a web page. If creating multiple charts on the
                    same web page, you won't need to re-import the libraries
                    when creating additional charts.
+            labels - If True, displays labels on the chart for data points.
+            legend - If True, displays the data point legend on the chart.
         """
         if not chart_name:
             chart_name = "default"
@@ -4108,24 +4111,28 @@ def create_pie_chart(
         style = "pie"
         self.__create_highchart(
             chart_name=chart_name, title=title, subtitle=subtitle,
-            style=style, data_name=data_name, unit=unit, libs=libs)
+            style=style, data_name=data_name, unit=unit, libs=libs,
+            labels=labels, legend=legend)
 
     def create_bar_chart(
             self, chart_name=None, title=None, subtitle=None,
-            data_name=None, unit=None, libs=True):
+            data_name=None, unit=None, libs=True, labels=True, legend=True):
         """ Creates a JavaScript bar chart using "HighCharts".
             @Params
             chart_name - If creating multiple charts,
                          use this to select which one.
             title - The title displayed for the chart.
             subtitle - The subtitle displayed for the chart.
-            data_name - Set the series name. Useful for multi-series charts.
+            data_name - The series name. Useful for multi-series charts.
+                        If no data_name, will default to using "Series 1".
             unit - The description label given to the chart's y-axis values.
             libs - The option to include Chart libraries (JS and CSS files).
                    Should be set to True (default) for the first time creating
                    a chart on a web page. If creating multiple charts on the
                    same web page, you won't need to re-import the libraries
                    when creating additional charts.
+            labels - If True, displays labels on the chart for data points.
+            legend - If True, displays the data point legend on the chart.
         """
         if not chart_name:
             chart_name = "default"
@@ -4134,24 +4141,28 @@ def create_bar_chart(
         style = "bar"
         self.__create_highchart(
             chart_name=chart_name, title=title, subtitle=subtitle,
-            style=style, data_name=data_name, unit=unit, libs=libs)
+            style=style, data_name=data_name, unit=unit, libs=libs,
+            labels=labels, legend=legend)
 
     def create_column_chart(
             self, chart_name=None, title=None, subtitle=None,
-            data_name=None, unit=None, libs=True):
+            data_name=None, unit=None, libs=True, labels=True, legend=True):
         """ Creates a JavaScript column chart using "HighCharts".
             @Params
             chart_name - If creating multiple charts,
                          use this to select which one.
             title - The title displayed for the chart.
             subtitle - The subtitle displayed for the chart.
-            data_name - Set the series name. Useful for multi-series charts.
+            data_name - The series name. Useful for multi-series charts.
+                        If no data_name, will default to using "Series 1".
             unit - The description label given to the chart's y-axis values.
             libs - The option to include Chart libraries (JS and CSS files).
                    Should be set to True (default) for the first time creating
                    a chart on a web page. If creating multiple charts on the
                    same web page, you won't need to re-import the libraries
                    when creating additional charts.
+            labels - If True, displays labels on the chart for data points.
+            legend - If True, displays the data point legend on the chart.
         """
         if not chart_name:
             chart_name = "default"
@@ -4160,25 +4171,30 @@ def create_column_chart(
         style = "column"
         self.__create_highchart(
             chart_name=chart_name, title=title, subtitle=subtitle,
-            style=style, data_name=data_name, unit=unit, libs=libs)
+            style=style, data_name=data_name, unit=unit, libs=libs,
+            labels=labels, legend=legend)
 
     def create_line_chart(
             self, chart_name=None, title=None, subtitle=None,
-            data_name=None, unit=None, zero=False, libs=True):
+            data_name=None, unit=None, zero=False, libs=True,
+            labels=True, legend=True):
         """ Creates a JavaScript line chart using "HighCharts".
             @Params
             chart_name - If creating multiple charts,
                          use this to select which one.
             title - The title displayed for the chart.
             subtitle - The subtitle displayed for the chart.
-            data_name - Set the series name. Useful for multi-series charts.
+            data_name - The series name. Useful for multi-series charts.
+                        If no data_name, will default to using "Series 1".
             unit - The description label given to the chart's y-axis values.
             zero - If True, the y-axis always starts at 0. (Default: False).
             libs - The option to include Chart libraries (JS and CSS files).
                    Should be set to True (default) for the first time creating
                    a chart on a web page. If creating multiple charts on the
                    same web page, you won't need to re-import the libraries
                    when creating additional charts.
+            labels - If True, displays labels on the chart for data points.
+            legend - If True, displays the data point legend on the chart.
         """
         if not chart_name:
             chart_name = "default"
@@ -4187,25 +4203,30 @@ def create_line_chart(
         style = "line"
         self.__create_highchart(
             chart_name=chart_name, title=title, subtitle=subtitle,
-            style=style, data_name=data_name, unit=unit, zero=zero, libs=libs)
+            style=style, data_name=data_name, unit=unit, zero=zero, libs=libs,
+            labels=labels, legend=legend)
 
     def create_area_chart(
             self, chart_name=None, title=None, subtitle=None,
-            data_name=None, unit=None, zero=False, libs=True):
+            data_name=None, unit=None, zero=False, libs=True,
+            labels=True, legend=True):
         """ Creates a JavaScript area chart using "HighCharts".
             @Params
             chart_name - If creating multiple charts,
                          use this to select which one.
             title - The title displayed for the chart.
             subtitle - The subtitle displayed for the chart.
-            data_name - Set the series name. Useful for multi-series charts.
+            data_name - The series name. Useful for multi-series charts.
+                        If no data_name, will default to using "Series 1".
             unit - The description label given to the chart's y-axis values.
             zero - If True, the y-axis always starts at 0. (Default: False).
             libs - The option to include Chart libraries (JS and CSS files).
                    Should be set to True (default) for the first time creating
                    a chart on a web page. If creating multiple charts on the
                    same web page, you won't need to re-import the libraries
                    when creating additional charts.
+            labels - If True, displays labels on the chart for data points.
+            legend - If True, displays the data point legend on the chart.
         """
         if not chart_name:
             chart_name = "default"
@@ -4214,11 +4235,13 @@ def create_area_chart(
         style = "area"
         self.__create_highchart(
             chart_name=chart_name, title=title, subtitle=subtitle,
-            style=style, data_name=data_name, unit=unit, zero=zero, libs=libs)
+            style=style, data_name=data_name, unit=unit, zero=zero, libs=libs,
+            labels=labels, legend=legend)
 
     def __create_highchart(
             self, chart_name=None, title=None, subtitle=None,
-            style=None, data_name=None, unit=None, zero=False, libs=True):
+            style=None, data_name=None, unit=None, zero=False, libs=True,
+            labels=True, legend=True):
         """ Creates a JavaScript chart using the "HighCharts" library. """
         if not chart_name:
             chart_name = "default"
@@ -4232,6 +4255,14 @@ def __create_highchart(
             data_name = "Series 1"
         if not unit:
             unit = "Values"
+        if labels:
+            labels = "true"
+        else:
+            labels = "false"
+        if legend:
+            legend = "true"
+        else:
+            legend = "false"
         title = title.replace("'", "\\'")
         subtitle = subtitle.replace("'", "\\'")
         unit = unit.replace("'", "\\'")
@@ -4355,25 +4386,45 @@ def __create_highchart(
                     padding: '6px',
                     fontSize: '14px'
                 },
+                backgroundColor: {
+                    linearGradient: {
+                        x1: 0,
+                        y1: 0,
+                        x2: 0,
+                        y2: 1
+                    },
+                    stops: [
+                        [0, 'rgba(255, 255, 255, 0.78)'],
+                        [0.5, 'rgba(235, 235, 235, 0.76)'],
+                        [1, 'rgba(244, 252, 255, 0.74)']
+                    ]
+                },
+                hideDelay: 40,
                 pointFormat: '%s'
             },
             """ % point_format)
         chart_init_3 = (
-            r"""
+            """
             accessibility: {
                 point: {
-                    valueSuffix: '%'
+                    valueSuffix: '%%'
                 }
             },
             plotOptions: {
+                series: {
+                    states: {
+                        inactive: {
+                            opacity: 0.85
+                        }
+                    }
+                },
                 pie: {
-                    size: "95%",
+                    size: "95%%",
                     allowPointSelect: true,
                     animation: false,
                     cursor: 'pointer',
                     dataLabels: {
-                        // enabled: false,
-                        // format: '{point.name}: {point.y:.0f}',
+                        enabled: %s,
                         formatter: function() {
                           if (this.y > 0) {
                             return this.point.name + ': ' + this.point.y
@@ -4385,10 +4436,10 @@ def __create_highchart(
                             enabled: true
                         }
                     },
-                    showInLegend: true
+                    showInLegend: %s
                 }
             },
-            """)
+            """ % (labels, legend))
         if style != "pie":
             chart_init_3 = (
                 """
@@ -4406,11 +4457,11 @@ def __create_highchart(
                 },
                 plotOptions: {
                     series: {
-                        showInLegend: true,
-                        animation: false,
                         dataLabels: {
-                            enabled: true
+                            enabled: %s
                         },
+                        showInLegend: %s,
+                        animation: false,
                         shadow: false,
                         lineWidth: 3,
                         fillOpacity: 0.5,
@@ -4419,7 +4470,7 @@ def __create_highchart(
                         }
                     }
                 },
-                """)
+                """ % (labels, legend))
         chart_init = chart_init_1 + chart_init_2 + chart_init_3
         color_by_point = "true"
         if style != "pie":