Highcharts .NET  11.3.0
Highsoft.Web.Mvc.Charts.ChartEvents Class Reference

Inherits BaseObject.

Properties

string AddSeries [get, set]
 Fires when a series is added to the chart after load time, using theaddSeries method. One parameter, event, is passed to thefunction, containing common event information. Throughevent.options you can access the series options that were passed tothe addSeries method. Returning false prevents the series frombeing added. More...
 
string AfterPrint [get, set]
 Fires after a chart is printed through the context menu item or theChart.print method. More...
 
string BeforePrint [get, set]
 Fires before a chart is printed through the context menu item orthe Chart.print method. More...
 
string Click [get, set]
 Fires when clicking on the plot background. One parameter, event,is passed to the function, containing common event information.Information on the clicked spot can be found through event.xAxisand event.yAxis, which are arrays containing the axes of eachdimension and each axis' value at the clicked spot. The primary axesare event.xAxis[0] and event.yAxis[0]. Remember the unit of adatetime axis is milliseconds since 1970-01-01 00:00:00.jsclick: function(e) { console.log( Highcharts.dateFormat('Y-m-d H:M:S', e.xAxis[0].value), e.yAxis[0].value )} More...
 
string Drilldown [get, set]
 Fires when a drilldown point is clicked, before the new series is added. Thisevent is also utilized for async drilldown, where the seriesOptions are notadded by option, but rather loaded async. Note that when clicking a categorylabel to trigger multiple series drilldown, one drilldown event istriggered per point in the category.Event arguments:- category: If a category label was clicked, which index.- originalEvent: The original browser event (usually click) that triggered the drilldown.- point: The originating point.- points: If a category label was clicked, this array holds all points corresponding to the category.- seriesOptions: Options for the new series. More...
 
string Drillup [get, set]
 Fires when drilling up from a drilldown series. More...
 
string Drillupall [get, set]
 In a chart with multiple drilldown series, this event fires after all theseries have been drilled up. More...
 
string ExportData [get, set]
 Callback that fires while exporting data. This allows the modification ofdata rows before processed into the final format. More...
 
string FullscreenClose [get, set]
 Fires when a fullscreen is closed through the context menu item,or a fullscreen is closed on the Escape button click,or the Chart.fullscreen.close method. More...
 
string FullscreenOpen [get, set]
 Fires when a fullscreen is opened through the context menu item,or the Chart.fullscreen.open method. More...
 
string Load [get, set]
 Fires when the chart is finished loading. Since v4.2.2, it also waitsfor images to be loaded, for example from point markers. Oneparameter, event, is passed to the function, containing commonevent information.There is also a second parameter to the chart constructor where acallback function can be passed to be executed on chart.load. More...
 
string Redraw [get, set]
 Fires when the chart is redrawn, either after a call tochart.redraw() or after an axis, series or point is modified withthe redraw option set to true. One parameter, event, is passedto the function, containing common event information. More...
 
string Render [get, set]
 Fires after initial load of the chart (directly after the loadevent), and after each redraw (directly after the redraw event). More...
 
string Selection [get, set]
 Fires when an area of the chart has been selected. Selection isenabled by setting the chart's zoomType. One parameter, event, ispassed to the function, containing common event information. Thedefault action for the selection event is to zoom the chart to theselected area. It can be prevented by callingevent.preventDefault() or return false.Information on the selected area can be found through event.xAxisand event.yAxis, which are arrays containing the axes of eachdimension and each axis' min and max values. The primary axes areevent.xAxis[0] and event.yAxis[0]. Remember the unit of adatetime axis is milliseconds since 1970-01-01 00:00:00.jsselection: function(event) { // log the min and max of the primary, datetime x-axis console.log( Highcharts.dateFormat( 'Y-m-d H:M:S', event.xAxis[0].min ), Highcharts.dateFormat( 'Y-m-d H:M:S', event.xAxis[0].max ) ); // log the min and max of the y axis console.log(event.yAxis[0].min, event.yAxis[0].max);} More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ AddSeries

string Highsoft.Web.Mvc.Charts.ChartEvents.AddSeries
getset

Fires when a series is added to the chart after load time, using theaddSeries method. One parameter, event, is passed to thefunction, containing common event information. Throughevent.options you can access the series options that were passed tothe addSeries method. Returning false prevents the series frombeing added.

◆ AfterPrint

string Highsoft.Web.Mvc.Charts.ChartEvents.AfterPrint
getset

Fires after a chart is printed through the context menu item or theChart.print method.

◆ BeforePrint

string Highsoft.Web.Mvc.Charts.ChartEvents.BeforePrint
getset

Fires before a chart is printed through the context menu item orthe Chart.print method.

◆ Click

string Highsoft.Web.Mvc.Charts.ChartEvents.Click
getset

Fires when clicking on the plot background. One parameter, event,is passed to the function, containing common event information.Information on the clicked spot can be found through event.xAxisand event.yAxis, which are arrays containing the axes of eachdimension and each axis' value at the clicked spot. The primary axesare event.xAxis[0] and event.yAxis[0]. Remember the unit of adatetime axis is milliseconds since 1970-01-01 00:00:00.jsclick: function(e) { console.log( Highcharts.dateFormat('Y-m-d H:M:S', e.xAxis[0].value), e.yAxis[0].value )}

◆ Drilldown

string Highsoft.Web.Mvc.Charts.ChartEvents.Drilldown
getset

Fires when a drilldown point is clicked, before the new series is added. Thisevent is also utilized for async drilldown, where the seriesOptions are notadded by option, but rather loaded async. Note that when clicking a categorylabel to trigger multiple series drilldown, one drilldown event istriggered per point in the category.Event arguments:- category: If a category label was clicked, which index.- originalEvent: The original browser event (usually click) that triggered the drilldown.- point: The originating point.- points: If a category label was clicked, this array holds all points corresponding to the category.- seriesOptions: Options for the new series.

◆ Drillup

string Highsoft.Web.Mvc.Charts.ChartEvents.Drillup
getset

Fires when drilling up from a drilldown series.

◆ Drillupall

string Highsoft.Web.Mvc.Charts.ChartEvents.Drillupall
getset

In a chart with multiple drilldown series, this event fires after all theseries have been drilled up.

◆ ExportData

string Highsoft.Web.Mvc.Charts.ChartEvents.ExportData
getset

Callback that fires while exporting data. This allows the modification ofdata rows before processed into the final format.

◆ FullscreenClose

string Highsoft.Web.Mvc.Charts.ChartEvents.FullscreenClose
getset

Fires when a fullscreen is closed through the context menu item,or a fullscreen is closed on the Escape button click,or the Chart.fullscreen.close method.

◆ FullscreenOpen

string Highsoft.Web.Mvc.Charts.ChartEvents.FullscreenOpen
getset

Fires when a fullscreen is opened through the context menu item,or the Chart.fullscreen.open method.

◆ Load

string Highsoft.Web.Mvc.Charts.ChartEvents.Load
getset

Fires when the chart is finished loading. Since v4.2.2, it also waitsfor images to be loaded, for example from point markers. Oneparameter, event, is passed to the function, containing commonevent information.There is also a second parameter to the chart constructor where acallback function can be passed to be executed on chart.load.

◆ Redraw

string Highsoft.Web.Mvc.Charts.ChartEvents.Redraw
getset

Fires when the chart is redrawn, either after a call tochart.redraw() or after an axis, series or point is modified withthe redraw option set to true. One parameter, event, is passedto the function, containing common event information.

◆ Render

string Highsoft.Web.Mvc.Charts.ChartEvents.Render
getset

Fires after initial load of the chart (directly after the loadevent), and after each redraw (directly after the redraw event).

◆ Selection

string Highsoft.Web.Mvc.Charts.ChartEvents.Selection
getset

Fires when an area of the chart has been selected. Selection isenabled by setting the chart's zoomType. One parameter, event, ispassed to the function, containing common event information. Thedefault action for the selection event is to zoom the chart to theselected area. It can be prevented by callingevent.preventDefault() or return false.Information on the selected area can be found through event.xAxisand event.yAxis, which are arrays containing the axes of eachdimension and each axis' min and max values. The primary axes areevent.xAxis[0] and event.yAxis[0]. Remember the unit of adatetime axis is milliseconds since 1970-01-01 00:00:00.jsselection: function(event) { // log the min and max of the primary, datetime x-axis console.log( Highcharts.dateFormat( 'Y-m-d H:M:S', event.xAxis[0].min ), Highcharts.dateFormat( 'Y-m-d H:M:S', event.xAxis[0].max ) ); // log the min and max of the y axis console.log(event.yAxis[0].min, event.yAxis[0].max);}


The documentation for this class was generated from the following file: