Class ResultHighchart

    • Constructor Detail

      • ResultHighchart

        public ResultHighchart​(Map<String,​?> definition)
        Not intended for public use. Using this constructor will not fully initialize the instance, please prefer api.buildHighchart().
        See Also:
        PublicGroovyAPI#buildHighchart
    • Method Detail

      • getChartDefinition

        public Map<String,​?> getChartDefinition()
        Not intended for public use, required for JSON serialization.
      • addModule

        public ResultHighchart addModule​(String... modules)
        By default, only the modules required for the various Price Analyzer chart types are available. If your chart requires additional modules, they can be specified here. The application ensures the files load only once.
        Parameters:
        modules - one or more Highcharts module names, without the path and without the ".js" extension. e.g. "annotations", "funnel", "variwide"
        Returns:
        the ResultHighchart instance, for convenience
        See Also:
        https://www.highcharts.com/docs to find out what modules are needed for each chart type.
      • getModulesList

        public List<String> getModulesList()
        Not intended for public use, required for JSON serialization.
      • getShowDataTab

        public boolean getShowDataTab()
        Not intended for public use, required for JSON serialization.
      • setDataHeaders

        public ResultHighchart setDataHeaders​(String... headers)
        To override the default column headers of the data tab table. For convenience, this will also call setShowDataTab(true)
        Parameters:
        headers - One or more header labels, left to right
        Returns:
        the ResultHighchart instance, for convenience
      • getDataHeaders

        public List<String> getDataHeaders()
        Not intended for public use, required for JSON serialization.
      • setResultMatrixTabs

        public ResultHighchart setResultMatrixTabs​(ResultMatrix... matrices)
        The automatically filled data tab can be replaced by customized ResultMatrix data. It's even possible to add multiple tabs by providing multiple ResultMatrix instances. Make sure to set a title via ResultMatrix.setTitle() as this will be used for the tab label. Note that:
        • This method will overwrite any previously set or added ResultMatrix
        • For convenience, this will also call setShowDataTab(true)
        Parameters:
        matrices - One or more ResultMatrix instances to display in the tab set
        Returns:
        the ResultHighchart instance, for convenience
        See Also:
        setShowDataTab(boolean)
      • addResultMatrixTab

        public ResultHighchart addResultMatrixTab​(ResultMatrix matrix)
        The automatically filled data tab can be replaced by customized ResultMatrix data. It's even possible to add multiple tabs by providing multiple ResultMatrix instances. Make sure to set a title via ResultMatrix.setTitle() as this will be used for the tab label. Note that:
        • This method will not overwrite previously set or added ResultMatrix
        • For convenience, this will also call setShowDataTab(true)
        Parameters:
        matrices - One or more ResultMatrix instances to display in the tab set
        Returns:
        the ResultHighchart instance, for convenience
        See Also:
        setShowDataTab(boolean)
      • getResultMatrixList

        public List<ResultMatrix> getResultMatrixList()
        Not intended for public use, required for JSON serialization.
      • getResultType

        public String getResultType()
        Specified by:
        getResultType in interface ComplexCalculationResult
      • onPointClick

        public ResultHighchart.OnPointClick onPointClick()
        BETA
        Allows to define events that will be triggered when the user clicks in the chart/map.
        Example:
             def chart = api.buildHighchart(definition)
             chart.onPointClick().triggerEvent(api.dashboardWideEvent("eventName"))
                 .withNameAsEventDataAttr().withCustomEventDataAttr("value")
             return chart
         
        This allows to refresh an embedded dashboard:
             return api.dashboard("embeddedDashboardName")
                 //.setParam("country_name", api.input("Country"))
                 //.setParam("country_revenue", api.input("Revenu"))
                 .showEmbedded()
                 .andRecalculateOn(api.dashboardWideEvent("eventName"))
                 .withEventDataAttr("name").asParam("country_name)
                 .withEventDataAttr("value").asParam("country_revenue")
         
      • getEvents

        public List<Map<String,​String>> getEvents()
        Not intended for public use, required for JSON serialization.