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

Inherits BaseObject.

Properties

string BeforeParse [get, set]
 A callback function to modify the CSV before parsing it. Return the modifiedstring. More...
 
List< List< string > > Columns [get, set]
 A two-dimensional array representing the input data on tabular form.This input can be used when the data is already parsed, for examplefrom a grid view component. Each cell can be a string or number.If not switchRowsAndColumns is set, the columns are interpreted asseries. More...
 
string ColumnsURL [get, set]
 A URL to a remote JSON dataset, structured as a column array.Will be fetched when the chart is created using Ajax. More...
 
DataColumnTypes ColumnTypes [get, set]
 An array option that specifies the data type for each column in the seriesloaded within the data module.Possible values: "string", "number", "float", "date". More...
 
string Complete [get, set]
 The callback that is evaluated when the data is finished loading,optionally from an external source, and parsed. The first argumentpassed is a finished chart options object, containing the series.These options can be extended with additional options and passeddirectly to the chart constructor. More...
 
string Csv [get, set]
 A comma delimited string to be parsed. Related options are startRow, endRow, startColumnand endColumn to delimit what part of the tableis used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats.The built-in CSV parser doesn't support all flavours of CSV, so insome cases it may be necessary to use an external CSV parser. Seethis example of parsingCSV through the MIT licensed Papa Parselibrary. More...
 
string CsvURL [get, set]
 An URL to a remote CSV dataset. Will be fetched when the chart is createdusing Ajax. More...
 
double DataRefreshRate [get, set]
 Sets the refresh rate for data polling when importing remote dataset bysetting data.csvURL, data.rowsURL,data.columnsURL, ordata.googleSpreadsheetKey.Note that polling must be enabled by settingdata.enablePolling to true.The value is the number of seconds between pollings.It cannot be set to less than 1 second. More...
 
string DateFormat [get, set]
 Which of the predefined date formats in Date.prototype.dateFormatsto use to parse date values. Defaults to a best guess based on whatformat gives valid and ordered dates. Valid options include: YYYY/mm/dd,dd/mm/YYYY, mm/dd/YYYY, dd/mm/YY, mm/dd/YY. More...
 
string DecimalPoint [get, set]
 The decimal point used for parsing numbers in the CSV.If both this and data.delimiter is set to undefined, the parser willattempt to deduce the decimal point automatically. More...
 
bool EnablePolling [get, set]
 Enables automatic refetching of remote datasets every n seconds (defined bysetting data.dataRefreshRate).Only works when either data.csvURL,data.rowsURL, data.columnsURL, ordata.googleSpreadsheetKey. More...
 
double EndColumn [get, set]
 In tabular input data, the last column (indexed by 0) to use. Defaultsto the last column containing data. More...
 
double EndRow [get, set]
 In tabular input data, the last row (indexed by 0) to use. Defaultsto the last row containing data. More...
 
bool FirstRowAsNames [get, set]
 Whether to use the first row in the data set as series names. More...
 
string GoogleAPIKey [get, set]
 The Google Spreadsheet API key required for access generated at API Services/ Credentials. See acomprehensive tutorial for setting up the key at theHands-On Data Visualizationbook website. More...
 
string GoogleSpreadsheetKey [get, set]
 The key or spreadsheetId value for a Google Spreadsheet to load. Seedevelopers.google.comfor how to find the spreadsheetId.In order for Google Sheets to load, a valid googleAPIKeymust also be given. More...
 
string GoogleSpreadsheetRange [get, set]
 The Google Spreadsheet range to use in combination withgoogleSpreadsheetKey. Seedevelopers.google.comfor details.If given, it takes precedence over startColumn, endColumn, startRow andendRow. More...
 
string GoogleSpreadsheetWorksheet [get, set]
 No longer works since v9.2.2, that uses Google Sheets API v4. Instead, usethe googleSpreadsheetRange option to load aspecific sheet. More...
 
string ItemDelimiter [get, set]
 Item or cell delimiter for parsing CSV. Defaults to the tab character\t if a tab character is found in the CSV string, if not it defaultsto ,.If this is set to false or undefined, the parser will attempt to deducethe delimiter automatically. More...
 
string LineDelimiter [get, set]
 Line delimiter for parsing CSV. More...
 
string Parsed [get, set]
 A callback function to access the parsed columns, the two-dimentionalinput data array directly, before they are interpreted into seriesdata and categories. Return false to stop completion, or callthis.complete() to continue async. More...
 
string ParseDate [get, set]
 A callback function to parse string representations of dates intoJavaScript timestamps. Should return an integer timestamp on success. More...
 
List< List< string > > Rows [get, set]
 The same as the columns input option, but defining rows intead ofcolumns. More...
 
string RowsURL [get, set]
 A URL to a remote JSON dataset, structured as a row array.Will be fetched when the chart is created using Ajax. More...
 
List< List< double?> > SeriesMapping [get, set]
 An array containing dictionaries for each series. A dictionary exists ofPoint property names as the key and the CSV column index as the value. More...
 
double StartColumn [get, set]
 In tabular input data, the first column (indexed by 0) to use. More...
 
double StartRow [get, set]
 In tabular input data, the first row (indexed by 0) to use. More...
 
bool SwitchRowsAndColumns [get, set]
 Switch rows and columns of the input data, so that this.columnseffectively becomes the rows of the data set, and the rows are interpretedas series. More...
 
string Table [get, set]
 An HTML table or the id of such to be parsed as input data. Relatedoptions are startRow, endRow, startColumn and endColumn todelimit what part of the table is used. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ BeforeParse

string Highsoft.Web.Mvc.Charts.Data.BeforeParse
getset

A callback function to modify the CSV before parsing it. Return the modifiedstring.

◆ Columns

List<List<string> > Highsoft.Web.Mvc.Charts.Data.Columns
getset

A two-dimensional array representing the input data on tabular form.This input can be used when the data is already parsed, for examplefrom a grid view component. Each cell can be a string or number.If not switchRowsAndColumns is set, the columns are interpreted asseries.

◆ ColumnsURL

string Highsoft.Web.Mvc.Charts.Data.ColumnsURL
getset

A URL to a remote JSON dataset, structured as a column array.Will be fetched when the chart is created using Ajax.

◆ ColumnTypes

DataColumnTypes Highsoft.Web.Mvc.Charts.Data.ColumnTypes
getset

An array option that specifies the data type for each column in the seriesloaded within the data module.Possible values: "string", "number", "float", "date".

◆ Complete

string Highsoft.Web.Mvc.Charts.Data.Complete
getset

The callback that is evaluated when the data is finished loading,optionally from an external source, and parsed. The first argumentpassed is a finished chart options object, containing the series.These options can be extended with additional options and passeddirectly to the chart constructor.

◆ Csv

string Highsoft.Web.Mvc.Charts.Data.Csv
getset

A comma delimited string to be parsed. Related options are startRow, endRow, startColumnand endColumn to delimit what part of the tableis used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats.The built-in CSV parser doesn't support all flavours of CSV, so insome cases it may be necessary to use an external CSV parser. Seethis example of parsingCSV through the MIT licensed Papa Parselibrary.

◆ CsvURL

string Highsoft.Web.Mvc.Charts.Data.CsvURL
getset

An URL to a remote CSV dataset. Will be fetched when the chart is createdusing Ajax.

◆ DataRefreshRate

double Highsoft.Web.Mvc.Charts.Data.DataRefreshRate
getset

Sets the refresh rate for data polling when importing remote dataset bysetting data.csvURL, data.rowsURL,data.columnsURL, ordata.googleSpreadsheetKey.Note that polling must be enabled by settingdata.enablePolling to true.The value is the number of seconds between pollings.It cannot be set to less than 1 second.

◆ DateFormat

string Highsoft.Web.Mvc.Charts.Data.DateFormat
getset

Which of the predefined date formats in Date.prototype.dateFormatsto use to parse date values. Defaults to a best guess based on whatformat gives valid and ordered dates. Valid options include: YYYY/mm/dd,dd/mm/YYYY, mm/dd/YYYY, dd/mm/YY, mm/dd/YY.

◆ DecimalPoint

string Highsoft.Web.Mvc.Charts.Data.DecimalPoint
getset

The decimal point used for parsing numbers in the CSV.If both this and data.delimiter is set to undefined, the parser willattempt to deduce the decimal point automatically.

◆ EnablePolling

bool Highsoft.Web.Mvc.Charts.Data.EnablePolling
getset

Enables automatic refetching of remote datasets every n seconds (defined bysetting data.dataRefreshRate).Only works when either data.csvURL,data.rowsURL, data.columnsURL, ordata.googleSpreadsheetKey.

◆ EndColumn

double Highsoft.Web.Mvc.Charts.Data.EndColumn
getset

In tabular input data, the last column (indexed by 0) to use. Defaultsto the last column containing data.

◆ EndRow

double Highsoft.Web.Mvc.Charts.Data.EndRow
getset

In tabular input data, the last row (indexed by 0) to use. Defaultsto the last row containing data.

◆ FirstRowAsNames

bool Highsoft.Web.Mvc.Charts.Data.FirstRowAsNames
getset

Whether to use the first row in the data set as series names.

◆ GoogleAPIKey

string Highsoft.Web.Mvc.Charts.Data.GoogleAPIKey
getset

The Google Spreadsheet API key required for access generated at API Services/ Credentials. See acomprehensive tutorial for setting up the key at theHands-On Data Visualizationbook website.

◆ GoogleSpreadsheetKey

string Highsoft.Web.Mvc.Charts.Data.GoogleSpreadsheetKey
getset

The key or spreadsheetId value for a Google Spreadsheet to load. Seedevelopers.google.comfor how to find the spreadsheetId.In order for Google Sheets to load, a valid googleAPIKeymust also be given.

◆ GoogleSpreadsheetRange

string Highsoft.Web.Mvc.Charts.Data.GoogleSpreadsheetRange
getset

The Google Spreadsheet range to use in combination withgoogleSpreadsheetKey. Seedevelopers.google.comfor details.If given, it takes precedence over startColumn, endColumn, startRow andendRow.

◆ GoogleSpreadsheetWorksheet

string Highsoft.Web.Mvc.Charts.Data.GoogleSpreadsheetWorksheet
getset

No longer works since v9.2.2, that uses Google Sheets API v4. Instead, usethe googleSpreadsheetRange option to load aspecific sheet.

◆ ItemDelimiter

string Highsoft.Web.Mvc.Charts.Data.ItemDelimiter
getset

Item or cell delimiter for parsing CSV. Defaults to the tab character\t if a tab character is found in the CSV string, if not it defaultsto ,.If this is set to false or undefined, the parser will attempt to deducethe delimiter automatically.

◆ LineDelimiter

string Highsoft.Web.Mvc.Charts.Data.LineDelimiter
getset

Line delimiter for parsing CSV.

◆ Parsed

string Highsoft.Web.Mvc.Charts.Data.Parsed
getset

A callback function to access the parsed columns, the two-dimentionalinput data array directly, before they are interpreted into seriesdata and categories. Return false to stop completion, or callthis.complete() to continue async.

◆ ParseDate

string Highsoft.Web.Mvc.Charts.Data.ParseDate
getset

A callback function to parse string representations of dates intoJavaScript timestamps. Should return an integer timestamp on success.

◆ Rows

List<List<string> > Highsoft.Web.Mvc.Charts.Data.Rows
getset

The same as the columns input option, but defining rows intead ofcolumns.

◆ RowsURL

string Highsoft.Web.Mvc.Charts.Data.RowsURL
getset

A URL to a remote JSON dataset, structured as a row array.Will be fetched when the chart is created using Ajax.

◆ SeriesMapping

List<List<double?> > Highsoft.Web.Mvc.Charts.Data.SeriesMapping
getset

An array containing dictionaries for each series. A dictionary exists ofPoint property names as the key and the CSV column index as the value.

◆ StartColumn

double Highsoft.Web.Mvc.Charts.Data.StartColumn
getset

In tabular input data, the first column (indexed by 0) to use.

◆ StartRow

double Highsoft.Web.Mvc.Charts.Data.StartRow
getset

In tabular input data, the first row (indexed by 0) to use.

◆ SwitchRowsAndColumns

bool Highsoft.Web.Mvc.Charts.Data.SwitchRowsAndColumns
getset

Switch rows and columns of the input data, so that this.columnseffectively becomes the rows of the data set, and the rows are interpretedas series.

◆ Table

string Highsoft.Web.Mvc.Charts.Data.Table
getset

An HTML table or the id of such to be parsed as input data. Relatedoptions are startRow, endRow, startColumn and endColumn todelimit what part of the table is used.


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