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

Inherits BaseObject.

Properties

PlotOptionsWordcloudAccessibility Accessibility [get, set]
 Accessibility options for a series. More...
 
bool AllowPointSelect [get, set]
 Allow this series' points to be selected by clicking on the graphic(columns, point markers, pie slices, map areas etc).The selected points can be handled by point select and unselectevents, or collectively by the getSelectedPoints function.And alternative way of selecting points is through dragging. More...
 
Animation Animation [get, set]
 
bool AnimationBool [get, set]
 Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types. More...
 
double AnimationLimit [get, set]
 For some series, there is a limit that shuts down animationby default when the total number of points in the chart is too high.For example, for a column chart and its derivatives, animation doesnot run if there is more than 250 points totally. To disable thiscap, set animationLimit to Infinity. This option works if animationis fired on individual points, not on a group of points like e.g. duringthe initial animation. More...
 
string BorderColor [get, set]
 The color of the border surrounding each column or bar.In styled mode, the border stroke can be set with the<tt>.highcharts-point rule. More...
 
Object BorderRadius [get, set]
 The corner radius of the border surrounding each column or bar. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa relative size. For columns this is relative to the column width, forpies it is relative to the radius and the inner radius. More...
 
string BorderRadiusString [get, set]
 The corner radius of the border surrounding each column or bar. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa relative size. For columns this is relative to the column width, forpies it is relative to the radius and the inner radius. More...
 
double BorderRadiusNumber [get, set]
 The corner radius of the border surrounding each column or bar. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa relative size. For columns this is relative to the column width, forpies it is relative to the radius and the inner radius. More...
 
double BorderWidth [get, set]
 
bool CenterInCategory [get, set]
 When true, the columns will center in the category, ignoring nullor missing points. When false, space will be reserved for null ormissing points. More...
 
string ClassName [get, set]
 An additional class name to apply to the series' graphical elements.This option does not replace default class names of the graphicalelement. Changes to the series' color will also be reflected in achart's legend and tooltip. More...
 
string Color [get, set]
 The main color of the series. In line type series it applies to theline and the point markers unless otherwise specified. In bar typeseries it applies to the bars unless a color is specified per point.The default value is pulled from the options.colors array.In styled mode, the color can be defined by thecolorIndex option. Also, the seriescolor can be set with the .highcharts-series,.highcharts-color-{n}, .highcharts-{type}-series or<tt>.highcharts-series-{n} class, or individual classes given by theclassName option. More...
 
bool ColorByPoint [get, set]
 
double ColorIndex [get, set]
 Styled mode only. A specific color index to use for the series, so itsgraphic representations are given the class name highcharts-color-{n}.Since v11, CSS variables on the form --highcharts-color-{n} makechanging the color scheme very convenient. More...
 
string ColorKey [get, set]
 Determines what data value should be used to calculate point colorif colorAxis is used. Requires to set min and max if somecustom point property is used or if approximation for data groupingis set to ‘'sum’`. More...
 
List< string > Colors [get, set]
 A series specific or series type specific color set to apply insteadof the global colors when colorByPoint is true. More...
 
PlotOptionsWordcloudCursor Cursor [get, set]
 You can set the cursor to "pointer" if you have click events attachedto the series, to signal to the user that the points and lines canbe clicked.In styled mode, the series cursor can be set with the same classesas listed under series.color. More...
 
Hashtable Custom [get, set]
 A reserved subspace to store options and values for customizedfunctionality. Here you can add additional data for your own eventcallbacks and formatter callbacks. More...
 
PlotOptionsWordcloudDashStyle DashStyle [get, set]
 Name of the dash style to use for the graph, or for some series typesthe outline of each shape.In styled mode, thestroke dash-arraycan be set with the same classes as listed underseries.color. More...
 
string Description [get, set]
 A description of the series to add to the screen reader informationabout the series. More...
 
double EdgeWidth [get, set]
 3D columns only. The width of the colored edges. More...
 
bool EnableMouseTracking [get, set]
 Enable or disable the mouse tracking for a specific series. Thisincludes point tooltips and click events on graphs and points. Forlarge datasets it improves performance. More...
 
PlotOptionsWordcloudEvents Events [get, set]
 General event handlers for the series items. These event hooks canalso be attached to the series at run time using theHighcharts.addEvent function. More...
 
bool InactiveOtherPoints [get, set]
 Highlight only the hovered point and fade the remaining points.Scatter-type series require enabling the 'inactive' marker state andadjusting opacity. Note that this approach could affect performancewith large datasets. More...
 
bool IncludeInDataExport [get, set]
 When set to false will prevent the series data from being included inany form of data export.Since version 6.0.0 until 7.1.0 the option was existing undocumentedas includeInCSVExport. More...
 
List< string > Keys [get, set]
 An array specifying which option maps to which key in the data pointarray. This makes it convenient to work with unstructured data arraysfrom different sources. More...
 
PlotOptionsWordcloudLabel Label [get, set]
 Series labels are placed as close to the series as possible in anatural way, seeking to avoid other series. The goal of thisfeature is to make the chart more easily readable, like if ahuman designer placed the labels in the optimal position.The series labels currently work with series types having agraph or an area. More...
 
PlotOptionsWordcloudLegendSymbol LegendSymbol [get, set]
 What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle. More...
 
string LinkedTo [get, set]
 The id of another series to link to. Additionally,the value can be ":previous" to link to the previous series. Whentwo series are linked, only the first one appears in the legend.Toggling the visibility of this also toggles the linked series.If master series uses data sorting and linked series does not haveits own sorting definition, the linked series will be sorted in thesame order as the master one. More...
 
double MaxFontSize [get, set]
 The word with the largest weight will have a font size equal to thisvalue. The font size of a word is the ratio between its weight andthe largest occuring weight, multiplied with the value ofmaxFontSize. More...
 
double MinFontSize [get, set]
 A threshold determining the minimum font size that can be applied toa word. More...
 
PlotOptionsWordcloudOnPoint OnPoint [get, set]
 Options for the Series on point feature. Only pie and sunburst seriesare supported at this moment. More...
 
double Opacity [get, set]
 Opacity of a series parts: line, fill (e.g. area) and dataLabels. More...
 
PlotOptionsWordcloudPlacementStrategy PlacementStrategy [get, set]
 This option decides which algorithm is used for placement, androtation of a word. The choice of algorith is therefore a crucialpart of the resulting layout of the wordcloud. It is possible forusers to add their own custom placement strategies for use in wordcloud. Read more about it in ourdocumentation More...
 
PlotOptionsWordcloudPoint Point [get, set]
 Properties for each single point. More...
 
string PointDescriptionFormat [get, set]
 Same asaccessibility.point.descriptionFormat,but for an individual series. Overrides the chart wide configuration. More...
 
string PointDescriptionFormatter [get, set]
 Same asaccessibility.series.descriptionFormatter,but for an individual series. Overrides the chart wide configuration. More...
 
bool RelativeXValue [get, set]
 When true, X values in the data set are relative to the currentpointStart, pointInterval and pointIntervalUnit settings. Thisallows compression of the data for datasets with irregular X values.The real X values are computed on the formula f(x) = ax + b, wherea is the pointInterval (optionally with a time unit given bypointIntervalUnit), and b is the pointStart. More...
 
PlotOptionsWordcloudRotation Rotation [get, set]
 Rotation options for the words in the wordcloud. More...
 
bool Selected [get, set]
 Whether to select the series initially. If showCheckbox is true,the checkbox next to the series name in the legend will be checkedfor a selected series. More...
 
bool ShowInLegend [get, set]
 
bool SkipKeyboardNavigation [get, set]
 If set to true, the accessibility module will skip past the pointsin this series for keyboard navigation. More...
 
PlotOptionsWordcloudSonification Sonification [get, set]
 Sonification/audio chart options for a series. More...
 
PlotOptionsWordcloudSpiral Spiral [get, set]
 Spiral used for placing a word after the initial positionexperienced a collision with either another word or the borders.It is possible for users to add their own custom spirallingalgorithms for use in word cloud. Read more about it in ourdocumentation More...
 
PlotOptionsWordcloudStates States [get, set]
 
bool StickyTracking [get, set]
 Sticky tracking of mouse events. When true, the mouseOut event on aseries isn't triggered until the mouse moves over another series, orout of the plot area. When false, the mouseOut event on a series istriggered when the mouse leaves the area around the series' graph ormarkers. This also implies the tooltip when not shared. WhenstickyTracking is false and tooltip.shared is false, the tooltipwill be hidden when moving the mouse between series. Defaults to truefor line and area type series, but to false for columns, pies etc.**Note:** The boost module will force this option because oftechnical limitations. More...
 
Hashtable Style [get, set]
 CSS styles for the words. More...
 
PlotOptionsWordcloudTooltip Tooltip [get, set]
 
double TurboThreshold [get, set]
 When a series contains a data array that is longer than this, onlyone dimensional arrays of numbers, or two dimensional arrays withx and y values are allowed. Also, only the first point is tested,and the rest are assumed to be the same format. This saves expensivedata checking and indexing in long series. Set it to 0 disable.Note:In boost mode turbo threshold is forced. Only array of numbers ortwo dimensional arrays are allowed. More...
 
bool Visible [get, set]
 Set the initial visibility of the series. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ Accessibility

PlotOptionsWordcloudAccessibility Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Accessibility
getset

Accessibility options for a series.

◆ AllowPointSelect

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.AllowPointSelect
getset

Allow this series' points to be selected by clicking on the graphic(columns, point markers, pie slices, map areas etc).The selected points can be handled by point select and unselectevents, or collectively by the getSelectedPoints function.And alternative way of selecting points is through dragging.

◆ Animation

Animation Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Animation
getset

◆ AnimationBool

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.AnimationBool
getset

Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types.

◆ AnimationLimit

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.AnimationLimit
getset

For some series, there is a limit that shuts down animationby default when the total number of points in the chart is too high.For example, for a column chart and its derivatives, animation doesnot run if there is more than 250 points totally. To disable thiscap, set animationLimit to Infinity. This option works if animationis fired on individual points, not on a group of points like e.g. duringthe initial animation.

◆ BorderColor

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.BorderColor
getset

The color of the border surrounding each column or bar.In styled mode, the border stroke can be set with the<tt>.highcharts-point rule.

◆ BorderRadius

Object Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.BorderRadius
getset

The corner radius of the border surrounding each column or bar. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa relative size. For columns this is relative to the column width, forpies it is relative to the radius and the inner radius.

◆ BorderRadiusNumber

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.BorderRadiusNumber
getset

The corner radius of the border surrounding each column or bar. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa relative size. For columns this is relative to the column width, forpies it is relative to the radius and the inner radius.

◆ BorderRadiusString

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.BorderRadiusString
getset

The corner radius of the border surrounding each column or bar. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa relative size. For columns this is relative to the column width, forpies it is relative to the radius and the inner radius.

◆ BorderWidth

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.BorderWidth
getset

◆ CenterInCategory

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.CenterInCategory
getset

When true, the columns will center in the category, ignoring nullor missing points. When false, space will be reserved for null ormissing points.

◆ ClassName

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.ClassName
getset

An additional class name to apply to the series' graphical elements.This option does not replace default class names of the graphicalelement. Changes to the series' color will also be reflected in achart's legend and tooltip.

◆ Color

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Color
getset

The main color of the series. In line type series it applies to theline and the point markers unless otherwise specified. In bar typeseries it applies to the bars unless a color is specified per point.The default value is pulled from the options.colors array.In styled mode, the color can be defined by thecolorIndex option. Also, the seriescolor can be set with the .highcharts-series,.highcharts-color-{n}, .highcharts-{type}-series or<tt>.highcharts-series-{n} class, or individual classes given by theclassName option.

◆ ColorByPoint

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.ColorByPoint
getset

◆ ColorIndex

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.ColorIndex
getset

Styled mode only. A specific color index to use for the series, so itsgraphic representations are given the class name highcharts-color-{n}.Since v11, CSS variables on the form --highcharts-color-{n} makechanging the color scheme very convenient.

◆ ColorKey

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.ColorKey
getset

Determines what data value should be used to calculate point colorif colorAxis is used. Requires to set min and max if somecustom point property is used or if approximation for data groupingis set to ‘'sum’`.

◆ Colors

List<string> Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Colors
getset

A series specific or series type specific color set to apply insteadof the global colors when colorByPoint is true.

◆ Cursor

PlotOptionsWordcloudCursor Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Cursor
getset

You can set the cursor to "pointer" if you have click events attachedto the series, to signal to the user that the points and lines canbe clicked.In styled mode, the series cursor can be set with the same classesas listed under series.color.

◆ Custom

Hashtable Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Custom
getset

A reserved subspace to store options and values for customizedfunctionality. Here you can add additional data for your own eventcallbacks and formatter callbacks.

◆ DashStyle

PlotOptionsWordcloudDashStyle Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.DashStyle
getset

Name of the dash style to use for the graph, or for some series typesthe outline of each shape.In styled mode, thestroke dash-arraycan be set with the same classes as listed underseries.color.

◆ Description

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Description
getset

A description of the series to add to the screen reader informationabout the series.

◆ EdgeWidth

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.EdgeWidth
getset

3D columns only. The width of the colored edges.

◆ EnableMouseTracking

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.EnableMouseTracking
getset

Enable or disable the mouse tracking for a specific series. Thisincludes point tooltips and click events on graphs and points. Forlarge datasets it improves performance.

◆ Events

PlotOptionsWordcloudEvents Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Events
getset

General event handlers for the series items. These event hooks canalso be attached to the series at run time using theHighcharts.addEvent function.

◆ InactiveOtherPoints

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.InactiveOtherPoints
getset

Highlight only the hovered point and fade the remaining points.Scatter-type series require enabling the 'inactive' marker state andadjusting opacity. Note that this approach could affect performancewith large datasets.

◆ IncludeInDataExport

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.IncludeInDataExport
getset

When set to false will prevent the series data from being included inany form of data export.Since version 6.0.0 until 7.1.0 the option was existing undocumentedas includeInCSVExport.

◆ Keys

List<string> Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Keys
getset

An array specifying which option maps to which key in the data pointarray. This makes it convenient to work with unstructured data arraysfrom different sources.

◆ Label

PlotOptionsWordcloudLabel Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Label
getset

Series labels are placed as close to the series as possible in anatural way, seeking to avoid other series. The goal of thisfeature is to make the chart more easily readable, like if ahuman designer placed the labels in the optimal position.The series labels currently work with series types having agraph or an area.

◆ LegendSymbol

PlotOptionsWordcloudLegendSymbol Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.LegendSymbol
getset

What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle.

◆ LinkedTo

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.LinkedTo
getset

The id of another series to link to. Additionally,the value can be ":previous" to link to the previous series. Whentwo series are linked, only the first one appears in the legend.Toggling the visibility of this also toggles the linked series.If master series uses data sorting and linked series does not haveits own sorting definition, the linked series will be sorted in thesame order as the master one.

◆ MaxFontSize

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.MaxFontSize
getset

The word with the largest weight will have a font size equal to thisvalue. The font size of a word is the ratio between its weight andthe largest occuring weight, multiplied with the value ofmaxFontSize.

◆ MinFontSize

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.MinFontSize
getset

A threshold determining the minimum font size that can be applied toa word.

◆ OnPoint

PlotOptionsWordcloudOnPoint Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.OnPoint
getset

Options for the Series on point feature. Only pie and sunburst seriesare supported at this moment.

◆ Opacity

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Opacity
getset

Opacity of a series parts: line, fill (e.g. area) and dataLabels.

◆ PlacementStrategy

PlotOptionsWordcloudPlacementStrategy Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.PlacementStrategy
getset

This option decides which algorithm is used for placement, androtation of a word. The choice of algorith is therefore a crucialpart of the resulting layout of the wordcloud. It is possible forusers to add their own custom placement strategies for use in wordcloud. Read more about it in ourdocumentation

◆ Point

PlotOptionsWordcloudPoint Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Point
getset

Properties for each single point.

◆ PointDescriptionFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.PointDescriptionFormat
getset

Same asaccessibility.point.descriptionFormat,but for an individual series. Overrides the chart wide configuration.

◆ PointDescriptionFormatter

string Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.PointDescriptionFormatter
getset

Same asaccessibility.series.descriptionFormatter,but for an individual series. Overrides the chart wide configuration.

◆ RelativeXValue

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.RelativeXValue
getset

When true, X values in the data set are relative to the currentpointStart, pointInterval and pointIntervalUnit settings. Thisallows compression of the data for datasets with irregular X values.The real X values are computed on the formula f(x) = ax + b, wherea is the pointInterval (optionally with a time unit given bypointIntervalUnit), and b is the pointStart.

◆ Rotation

PlotOptionsWordcloudRotation Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Rotation
getset

Rotation options for the words in the wordcloud.

◆ Selected

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Selected
getset

Whether to select the series initially. If showCheckbox is true,the checkbox next to the series name in the legend will be checkedfor a selected series.

◆ ShowInLegend

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.ShowInLegend
getset

◆ SkipKeyboardNavigation

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.SkipKeyboardNavigation
getset

If set to true, the accessibility module will skip past the pointsin this series for keyboard navigation.

◆ Sonification

PlotOptionsWordcloudSonification Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Sonification
getset

Sonification/audio chart options for a series.

◆ Spiral

PlotOptionsWordcloudSpiral Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Spiral
getset

Spiral used for placing a word after the initial positionexperienced a collision with either another word or the borders.It is possible for users to add their own custom spirallingalgorithms for use in word cloud. Read more about it in ourdocumentation

◆ States

PlotOptionsWordcloudStates Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.States
getset

◆ StickyTracking

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.StickyTracking
getset

Sticky tracking of mouse events. When true, the mouseOut event on aseries isn't triggered until the mouse moves over another series, orout of the plot area. When false, the mouseOut event on a series istriggered when the mouse leaves the area around the series' graph ormarkers. This also implies the tooltip when not shared. WhenstickyTracking is false and tooltip.shared is false, the tooltipwill be hidden when moving the mouse between series. Defaults to truefor line and area type series, but to false for columns, pies etc.**Note:** The boost module will force this option because oftechnical limitations.

◆ Style

Hashtable Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Style
getset

CSS styles for the words.

◆ Tooltip

PlotOptionsWordcloudTooltip Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Tooltip
getset

◆ TurboThreshold

double Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.TurboThreshold
getset

When a series contains a data array that is longer than this, onlyone dimensional arrays of numbers, or two dimensional arrays withx and y values are allowed. Also, only the first point is tested,and the rest are assumed to be the same format. This saves expensivedata checking and indexing in long series. Set it to 0 disable.Note:In boost mode turbo threshold is forced. Only array of numbers ortwo dimensional arrays are allowed.

◆ Visible

bool Highsoft.Web.Mvc.Charts.PlotOptionsWordcloud.Visible
getset

Set the initial visibility of the series.


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