994 lines
43 KiB
TypeScript
994 lines
43 KiB
TypeScript
/*!*
|
|
*
|
|
* Copyright (c) Highsoft AS. All rights reserved.
|
|
*
|
|
*!*/
|
|
import * as Highcharts from "../highcharts.src";
|
|
declare module "../highcharts.src" {
|
|
/**
|
|
* (Highcharts) Point accessibility options for a series.
|
|
*/
|
|
interface PlotTreegraphAccessibilityPointOptions {
|
|
/**
|
|
* (Highcharts) Date format to use for points on datetime axes when
|
|
* describing them to screen reader users.
|
|
*
|
|
* Defaults to the same format as in tooltip.
|
|
*
|
|
* For an overview of the replacement codes, see dateFormat.
|
|
*/
|
|
dateFormat?: string;
|
|
/**
|
|
* (Highcharts) Formatter function to determine the date/time format
|
|
* used with points on datetime axes when describing them to screen
|
|
* reader users. Receives one argument, `point`, referring to the point
|
|
* to describe. Should return a date format string compatible with
|
|
* dateFormat.
|
|
*/
|
|
dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
|
|
/**
|
|
* (Highcharts) Whether or not to describe points with the value `null`
|
|
* to assistive technology, such as screen readers.
|
|
*/
|
|
describeNull?: boolean;
|
|
/**
|
|
* (Highcharts) A format string to use instead of the default for point
|
|
* descriptions.
|
|
*
|
|
* The context of the format string is the point instance.
|
|
*
|
|
* As opposed to accessibility.point.valueDescriptionFormat, this option
|
|
* replaces the whole description.
|
|
*/
|
|
descriptionFormat?: string;
|
|
/**
|
|
* (Highcharts) Formatter function to use instead of the default for
|
|
* point descriptions. Same as
|
|
* `accessibility.point.descriptionFormatter`, but applies to a series
|
|
* instead of the whole chart.
|
|
*
|
|
* Note: Prefer using accessibility.point.valueDescriptionFormat instead
|
|
* if possible, as default functionality such as describing annotations
|
|
* will be preserved.
|
|
*/
|
|
descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
|
|
/**
|
|
* (Highcharts) Decimals to use for the values in the point
|
|
* descriptions. Uses tooltip.valueDecimals if not defined.
|
|
*/
|
|
valueDecimals?: number;
|
|
/**
|
|
* (Highcharts) Format to use for describing the values of data points
|
|
* to assistive technology - including screen readers. The point context
|
|
* is available as `{point}`.
|
|
*
|
|
* Other available context variables include `{index}`, `{value}`, and
|
|
* `{xDescription}`.
|
|
*
|
|
* Additionally, the series name, annotation info, and description added
|
|
* in `point.accessibility.description` is added by default if relevant.
|
|
* To override this, use the accessibility.point.descriptionFormatter
|
|
* option.
|
|
*/
|
|
valueDescriptionFormat?: string;
|
|
/**
|
|
* (Highcharts) Prefix to add to the values in the point descriptions.
|
|
* Uses tooltip.valuePrefix if not defined.
|
|
*/
|
|
valuePrefix?: string;
|
|
/**
|
|
* (Highcharts) Suffix to add to the values in the point descriptions.
|
|
* Uses tooltip.valueSuffix if not defined.
|
|
*/
|
|
valueSuffix?: string;
|
|
}
|
|
/**
|
|
* (Highcharts) CSS styles for the collapse button.
|
|
*
|
|
* In styled mode, the collapse button style is given in the
|
|
* `.highcharts-collapse-button` class.
|
|
*/
|
|
interface PlotTreegraphCollapseButtonStyleOptions {
|
|
cursor?: string;
|
|
fontSize?: number;
|
|
fontWeight?: string;
|
|
}
|
|
/**
|
|
* (Highcharts, Highstock, Highmaps, Gantt) Presentation attributes for the
|
|
* text path.
|
|
*/
|
|
interface PlotTreegraphDataLabelsLinkTextPathAttributesOptions {
|
|
startOffset?: number;
|
|
}
|
|
/**
|
|
* (Highcharts) A configuration object to define how the color of a child
|
|
* varies from the parent's color. The variation is distributed among the
|
|
* children of node. For example when setting brightness, the brightness
|
|
* change will range from the parent's original brightness on the first
|
|
* child, to the amount set in the `to` setting on the last node. This
|
|
* allows a gradient-like color scheme that sets children out from each
|
|
* other while highlighting the grouping on treemaps and sectors on sunburst
|
|
* charts.
|
|
*/
|
|
interface PlotTreegraphLevelsColorVariationOptions {
|
|
/**
|
|
* (Highcharts) The key of a color variation. Currently supports
|
|
* `brightness` only.
|
|
*/
|
|
key?: "brightness";
|
|
/**
|
|
* (Highcharts) The ending value of a color variation. The last sibling
|
|
* will receive this value.
|
|
*/
|
|
to?: number;
|
|
}
|
|
/**
|
|
* (Highcharts) Can set the options of dataLabels on each point which lies
|
|
* on the level. plotOptions.treemap.dataLabels for possible values.
|
|
*/
|
|
interface PlotTreegraphLevelsDataLabelsOptions {
|
|
/**
|
|
* (Highcharts) The alignment of the data label compared to the point.
|
|
* If `right`, the right side of the label should be touching the point.
|
|
* For points with an extent, like columns, the alignments also dictates
|
|
* how to align it inside the box, as given with the inside option. Can
|
|
* be one of `left`, `center` or `right`.
|
|
*/
|
|
align?: (Highcharts.AlignValue|null);
|
|
/**
|
|
* (Highcharts) Whether to allow data labels to overlap. To make the
|
|
* labels less sensitive for overlapping, the dataLabels.padding can be
|
|
* set to 0.
|
|
*/
|
|
allowOverlap?: boolean;
|
|
/**
|
|
* (Highcharts) Enable or disable the initial animation when a series is
|
|
* displayed for the `dataLabels`. The animation can also be set as a
|
|
* configuration object. Please note that this option only applies to
|
|
* the initial animation.
|
|
*
|
|
* 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.
|
|
*/
|
|
animation?: (boolean|Highcharts.PlotTreegraphLevelsDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
|
|
/**
|
|
* (Highcharts) The background color or gradient for the data label.
|
|
* Setting it to `auto` will use the point's color.
|
|
*/
|
|
backgroundColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
|
|
/**
|
|
* (Highcharts) The border color for the data label. Setting it to
|
|
* `auto` will use the point's color. Defaults to `undefined`.
|
|
*/
|
|
borderColor?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
|
|
/**
|
|
* (Highcharts) The border radius in pixels for the data label.
|
|
*/
|
|
borderRadius?: number;
|
|
/**
|
|
* (Highcharts) The border width in pixels for the data label.
|
|
*/
|
|
borderWidth?: number;
|
|
/**
|
|
* (Highcharts) A class name for the data label. Particularly in styled
|
|
* mode, this can be used to give each series' or point's data label
|
|
* unique styling. In addition to this option, a default color class
|
|
* name is added so that we can give the labels a contrast text shadow.
|
|
*/
|
|
className?: string;
|
|
/**
|
|
* (Highcharts) This options is deprecated. Use style.color instead.
|
|
*
|
|
* The text color for the data labels. Defaults to `undefined`. For
|
|
* certain series types, like column or map, the data labels can be
|
|
* drawn inside the points. In this case the data label will be drawn
|
|
* with maximum contrast by default. Additionally, it will be given a
|
|
* `text-outline` style with the opposite color, to further increase the
|
|
* contrast. This can be overridden by setting the `text-outline` style
|
|
* to `none` in the `dataLabels.style` option.
|
|
*
|
|
* @deprecated 10.3.0
|
|
*/
|
|
color?: Highcharts.ColorType;
|
|
/**
|
|
* (Highcharts) Whether to hide data labels that are outside the plot
|
|
* area. By default, the data label is moved inside the plot area
|
|
* according to the overflow option.
|
|
*/
|
|
crop?: boolean;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) Whether to defer displaying the data
|
|
* labels until the initial series animation has finished. Setting to
|
|
* `false` renders the data label immediately. If set to `true` inherits
|
|
* the defer time set in plotOptions.series.animation.
|
|
*/
|
|
defer?: boolean;
|
|
/**
|
|
* (Highcharts) Enable or disable the data labels.
|
|
*/
|
|
enabled?: boolean;
|
|
/**
|
|
* (Highcharts) A declarative filter to control of which data labels to
|
|
* display. The declarative filter is designed for use when callback
|
|
* functions are not available, like when the chart options require a
|
|
* pure JSON structure or for use with graphical editors. For
|
|
* programmatic control, use the `formatter` instead, and return
|
|
* `undefined` to disable a single data label.
|
|
*/
|
|
filter?: Highcharts.DataLabelsFilterOptionsObject;
|
|
/**
|
|
* (Highcharts) A format string for the data label. Available variables
|
|
* are the same as for `formatter`.
|
|
*/
|
|
format?: string;
|
|
/**
|
|
* (Highcharts) Callback JavaScript function to format the data label.
|
|
* Note that if a `format` is defined, the format takes precedence and
|
|
* the formatter is ignored.
|
|
*/
|
|
formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
|
|
/**
|
|
* (Highcharts) For points with an extent, like columns or map areas,
|
|
* whether to align the data label inside the box or to the actual value
|
|
* point. Defaults to `false` in most cases, `true` in stacked columns.
|
|
*/
|
|
inside?: boolean;
|
|
/**
|
|
* (Highcharts) Format for points with the value of null. Works
|
|
* analogously to format. `nullFormat` can be applied only to series
|
|
* which support displaying null points i.e `heatmap` or `tilemap`. Does
|
|
* not work with series that don't display null points, like `line`,
|
|
* `column`, `bar` or `pie`.
|
|
*/
|
|
nullFormat?: (boolean|string);
|
|
/**
|
|
* (Highcharts) Callback JavaScript function that defines formatting for
|
|
* points with the value of null. Works analogously to formatter.
|
|
* `nullFormatter` can be applied only to series which support
|
|
* displaying null points i.e `heatmap` or `tilemap`. Does not work with
|
|
* series that don't display null points, like `line`, `column`, `bar`
|
|
* or `pie`.
|
|
*/
|
|
nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
|
|
/**
|
|
* (Highcharts) How to handle data labels that flow outside the plot
|
|
* area. The default is `"justify"`, which aligns them inside the plot
|
|
* area. For columns and bars, this means it will be moved inside the
|
|
* bar. To display data labels outside the plot area, set `crop` to
|
|
* `false` and `overflow` to `"allow"`.
|
|
*/
|
|
overflow?: Highcharts.DataLabelsOverflowValue;
|
|
/**
|
|
* (Highcharts) When either the `borderWidth` or the `backgroundColor`
|
|
* is set, this is the padding within the box.
|
|
*/
|
|
padding?: number;
|
|
/**
|
|
* (Highcharts) Aligns data labels relative to points. If `center`
|
|
* alignment is not possible, it defaults to `right`.
|
|
*/
|
|
position?: Highcharts.AlignValue;
|
|
/**
|
|
* (Highcharts) Text rotation in degrees. Note that due to a more
|
|
* complex structure, backgrounds, borders and padding will be lost on a
|
|
* rotated data label.
|
|
*/
|
|
rotation?: number;
|
|
/**
|
|
* (Highcharts) The shadow of the box. Works best with `borderWidth` or
|
|
* `backgroundColor`. Since 2.3 the shadow can be an object
|
|
* configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
|
|
* `width`.
|
|
*/
|
|
shadow?: (boolean|Highcharts.ShadowOptionsObject);
|
|
/**
|
|
* (Highcharts) The name of a symbol to use for the border around the
|
|
* label. Symbols are predefined functions on the Renderer object.
|
|
*/
|
|
shape?: string;
|
|
/**
|
|
* (Highcharts) Styles for the label. The default `color` setting is
|
|
* `"contrast"`, which is a pseudo color that Highcharts picks up and
|
|
* applies the maximum contrast to the underlying point item, for
|
|
* example the bar in a bar chart.
|
|
*
|
|
* The `textOutline` is a pseudo property that applies an outline of the
|
|
* given width with the given color, which by default is the maximum
|
|
* contrast to the text. So a bright text color will result in a black
|
|
* text outline for maximum readability on a mixed background. In some
|
|
* cases, especially with grayscale text, the text outline doesn't work
|
|
* well, in which cases it can be disabled by setting it to `"none"`.
|
|
* When `useHTML` is true, the `textOutline` will not be picked up. In
|
|
* this, case, the same effect can be acheived through the `text-shadow`
|
|
* CSS property.
|
|
*
|
|
* For some series types, where each point has an extent, like for
|
|
* example tree maps, the data label may overflow the point. There are
|
|
* two strategies for handling overflow. By default, the text will wrap
|
|
* to multiple lines. The other strategy is to set `style.textOverflow`
|
|
* to `ellipsis`, which will keep the text on one line plus it will
|
|
* break inside long words.
|
|
*/
|
|
style?: Highcharts.CSSObject;
|
|
/**
|
|
* (Highcharts) Options for a label text which should follow marker's
|
|
* shape. Border and background are disabled for a label that follows a
|
|
* path.
|
|
*
|
|
* **Note:** Only SVG-based renderer supports this option. Setting
|
|
* `useHTML` to true will disable this option.
|
|
*/
|
|
textPath?: Highcharts.DataLabelsTextPathOptionsObject;
|
|
/**
|
|
* (Highcharts) Whether to use HTML to render the labels.
|
|
*/
|
|
useHTML?: boolean;
|
|
/**
|
|
* (Highcharts) The vertical alignment of a data label. Can be one of
|
|
* `top`, `middle` or `bottom`. The default value depends on the data,
|
|
* for instance in a column chart, the label is above positive values
|
|
* and below negative values.
|
|
*/
|
|
verticalAlign?: string;
|
|
/**
|
|
* (Highcharts) The x position offset of the label relative to the point
|
|
* in pixels.
|
|
*/
|
|
x?: number;
|
|
/**
|
|
* (Highcharts) The y position offset of the label relative to the point
|
|
* in pixels.
|
|
*/
|
|
y?: number;
|
|
/**
|
|
* (Highcharts) The z index of the data labels. Use a `zIndex` of 6 to
|
|
* display it above the series, or use a `zIndex` of 2 to display it
|
|
* behind the series.
|
|
*/
|
|
zIndex?: number;
|
|
}
|
|
interface PlotTreegraphLinkOptions {
|
|
/**
|
|
* (Highcharts) The color of the links between nodes.
|
|
*/
|
|
color?: Highcharts.ColorString;
|
|
cursor?: string;
|
|
/**
|
|
* (Highcharts) The line width of the links connecting nodes, in pixels.
|
|
*/
|
|
lineWidth?: number;
|
|
/**
|
|
* (Highcharts) Radius for the rounded corners of the links between
|
|
* nodes. Works for `default` link type.
|
|
*/
|
|
radius?: number;
|
|
/**
|
|
* (Highcharts) Type of the link shape.
|
|
*/
|
|
type?: ('curved'|'default'|'straight');
|
|
}
|
|
/**
|
|
* (Highcharts) Options for the _Series on point_ feature. Only `pie` and
|
|
* `sunburst` series are supported at this moment.
|
|
*/
|
|
interface PlotTreegraphOnPointOptions {
|
|
/**
|
|
* (Highcharts) Options for the connector in the _Series on point_
|
|
* feature.
|
|
*
|
|
* In styled mode, the connector can be styled with the
|
|
* `.highcharts-connector-seriesonpoint` class name.
|
|
*/
|
|
connectorOptions?: (Highcharts.PlotTreegraphOnPointConnectorOptions|Highcharts.SVGAttributes);
|
|
/**
|
|
* (Highcharts) The `id` of the point that we connect the series to.
|
|
* Only points with a given `plotX` and `plotY` values and map points
|
|
* are valid.
|
|
*/
|
|
id?: string;
|
|
/**
|
|
* (Highcharts) Options allowing to set a position and an offset of the
|
|
* series in the _Series on point_ feature.
|
|
*/
|
|
position?: (object|Highcharts.PlotTreegraphOnPointPositionOptions);
|
|
}
|
|
/**
|
|
* (Highcharts) A treegraph series is a diagram, which shows a relation
|
|
* between ancestors and descendants with a clear parent - child relation.
|
|
* The best examples of the dataStructures, which best reflect this chart
|
|
* are e.g. genealogy tree or directory structure.
|
|
*
|
|
* TODO change back the demo path
|
|
*
|
|
* In TypeScript the type option must always be set.
|
|
*
|
|
* Configuration options for the series are given in three levels:
|
|
*
|
|
* 1. Options for all series in a chart are defined in the
|
|
* plotOptions.series object.
|
|
*
|
|
* 2. Options for all `treegraph` series are defined in
|
|
* plotOptions.treegraph.
|
|
*
|
|
* 3. Options for one single series are given in the series instance array.
|
|
* (see online documentation for example)
|
|
*/
|
|
interface PlotTreegraphOptions {
|
|
/**
|
|
* (Highcharts) Accessibility options for a series.
|
|
*/
|
|
accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
|
|
/**
|
|
* (Highcharts) 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 unselect
|
|
* events, or collectively by the getSelectedPoints function.
|
|
*
|
|
* And alternative way of selecting points is through dragging.
|
|
*/
|
|
allowPointSelect?: boolean;
|
|
/**
|
|
* (Highcharts) Enable or disable the initial animation when a series is
|
|
* displayed. The animation can also be set as a configuration object.
|
|
* Please note that this option only applies to the initial animation of
|
|
* the series 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 browsers for
|
|
* several chart types.
|
|
*/
|
|
animation?: (boolean|Highcharts.AnimationOptionsObject);
|
|
/**
|
|
* (Highcharts) For some series, there is a limit that shuts down
|
|
* animation by default when the total number of points in the chart is
|
|
* too high. For example, for a column chart and its derivatives,
|
|
* animation does not run if there is more than 250 points totally. To
|
|
* disable this cap, set `animationLimit` to `Infinity`. This option
|
|
* works if animation is fired on individual points, not on a group of
|
|
* points like e.g. during the initial animation.
|
|
*/
|
|
animationLimit?: number;
|
|
/**
|
|
* (Highcharts) Sets the color blending in the boost module.
|
|
*/
|
|
boostBlending?: Highcharts.OptionsBoostBlendingValue;
|
|
/**
|
|
* (Highcharts) Set the point threshold for when a series should enter
|
|
* boost mode.
|
|
*
|
|
* Setting it to e.g. 2000 will cause the series to enter boost mode
|
|
* when there are 2000 or more points in the series.
|
|
*
|
|
* To disable boosting on the series, set the `boostThreshold` to 0.
|
|
* Setting it to 1 will force boosting.
|
|
*
|
|
* Note that the cropThreshold also affects this setting. When zooming
|
|
* in on a series that has fewer points than the `cropThreshold`, all
|
|
* points are rendered although outside the visible plot area, and the
|
|
* `boostThreshold` won't take effect.
|
|
*/
|
|
boostThreshold?: number;
|
|
/**
|
|
* (Highcharts) An additional class name to apply to the series'
|
|
* graphical elements. This option does not replace default class names
|
|
* of the graphical element. Changes to the series' color will also be
|
|
* reflected in a chart's legend and tooltip.
|
|
*/
|
|
className?: string;
|
|
/**
|
|
* (Highcharts) Disable this option to allow series rendering in the
|
|
* whole plotting area.
|
|
*
|
|
* **Note:** Clipping should be always enabled when chart.zoomType is
|
|
* set
|
|
*/
|
|
clip?: boolean;
|
|
/**
|
|
* (Highcharts) Options applied to collapse Button. The collape button
|
|
* is the small button which indicates, that the node is collapsable.
|
|
*/
|
|
collapseButton?: Highcharts.PlotTreegraphCollapseButtonOptions;
|
|
/**
|
|
* (Highcharts) The main color of the series. In line type series it
|
|
* applies to the line and the point markers unless otherwise specified.
|
|
* In bar type series 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 the colorIndex option.
|
|
* Also, the series color can be set with the `.highcharts-series`,
|
|
* `.highcharts-color-{n}`, `.highcharts-{type}-series` or
|
|
* `.highcharts-series-{n}` class, or individual classes given by the
|
|
* `className` option.
|
|
*/
|
|
color?: (Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject);
|
|
/**
|
|
* (Highcharts) When using automatic point colors pulled from the
|
|
* `options.colors` collection, this option determines whether the chart
|
|
* should receive one color per series or one color per point.
|
|
*/
|
|
colorByPoint?: boolean;
|
|
/**
|
|
* (Highcharts) Styled mode only. A specific color index to use for the
|
|
* series, so its graphic representations are given the class name
|
|
* `highcharts-color-{n}`.
|
|
*
|
|
* Since v11, CSS variables on the form `--highcharts-color-{n}` make
|
|
* changing the color scheme very convenient.
|
|
*/
|
|
colorIndex?: number;
|
|
/**
|
|
* (Highcharts) A series specific or series type specific color set to
|
|
* apply instead of the global colors when colorByPoint is true.
|
|
*/
|
|
colors?: Array<(Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject)>;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) When true, each point or column edge
|
|
* is rounded to its nearest pixel in order to render sharp on screen.
|
|
* In some cases, when there are a lot of densely packed columns, this
|
|
* leads to visible difference in column widths or distance between
|
|
* columns. In these cases, setting `crisp` to `false` may look better,
|
|
* even though each column is rendered blurry.
|
|
*/
|
|
crisp?: boolean;
|
|
/**
|
|
* (Highcharts) When the series contains less points than the crop
|
|
* threshold, all points are drawn, event if the points fall outside the
|
|
* visible plot area at the current zoom. The advantage of drawing all
|
|
* points (including markers and columns), is that animation is
|
|
* performed on updates. On the other hand, when the series contains
|
|
* more points than the crop threshold, the series data is cropped to
|
|
* only contain points that fall within the plot area. The advantage of
|
|
* cropping away invisible points is to increase performance on large
|
|
* series.
|
|
*/
|
|
cropThreshold?: number;
|
|
/**
|
|
* (Highcharts) You can set the cursor to "pointer" if you have click
|
|
* events attached to the series, to signal to the user that the points
|
|
* and lines can be clicked.
|
|
*
|
|
* In styled mode, the series cursor can be set with the same classes as
|
|
* listed under series.color.
|
|
*/
|
|
cursor?: (string|Highcharts.CursorValue);
|
|
/**
|
|
* (Highcharts) A reserved subspace to store options and values for
|
|
* customized functionality. Here you can add additional data for your
|
|
* own event callbacks and formatter callbacks.
|
|
*/
|
|
custom?: Highcharts.Dictionary<any>;
|
|
/**
|
|
* (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
|
|
* appearing on top of the nodes and links. For treegraph charts, data
|
|
* labels are visible for the nodes by default, but hidden for links.
|
|
* This is controlled by modifying the `nodeFormat`, and the `format`
|
|
* that applies to links and is an empty string by default.
|
|
*/
|
|
dataLabels?: (Highcharts.SeriesTreegraphDataLabelsOptionsObject|Array<Highcharts.SeriesTreegraphDataLabelsOptionsObject>);
|
|
/**
|
|
* (Highcharts) A description of the series to add to the screen reader
|
|
* information about the series.
|
|
*/
|
|
description?: string;
|
|
/**
|
|
* (Highcharts) Enable or disable the mouse tracking for a specific
|
|
* series. This includes point tooltips and click events on graphs and
|
|
* points. For large datasets it improves performance.
|
|
*/
|
|
enableMouseTracking?: boolean;
|
|
/**
|
|
* (Highcharts) General event handlers for the series items. These event
|
|
* hooks can also be attached to the series at run time using the
|
|
* `Highcharts.addEvent` function.
|
|
*/
|
|
events?: Highcharts.SeriesEventsOptionsObject;
|
|
/**
|
|
* (Highcharts) Whether the treegraph series should fill the entire plot
|
|
* area in the X axis direction, even when there are collapsed points.
|
|
*/
|
|
fillSpace?: boolean;
|
|
/**
|
|
* (Highcharts) Determines whether the series should look for the
|
|
* nearest point in both dimensions or just the x-dimension when
|
|
* hovering the series. Defaults to `'xy'` for scatter series and `'x'`
|
|
* for most other series. If the data has duplicate x-values, it is
|
|
* recommended to set this to `'xy'` to allow hovering over all points.
|
|
*
|
|
* Applies only to series types using nearest neighbor search (not
|
|
* direct hover) for tooltip.
|
|
*/
|
|
findNearestPointBy?: Highcharts.OptionsFindNearestPointByValue;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the
|
|
* total chart width or only the zoomed area when zooming in on parts of
|
|
* the X axis. By default, the Y axis adjusts to the min and max of the
|
|
* visible data. Cartesian series only.
|
|
*/
|
|
getExtremesFromAll?: boolean;
|
|
/**
|
|
* (Highcharts) Highlight only the hovered point and fade the remaining
|
|
* points.
|
|
*
|
|
* Scatter-type series require enabling the 'inactive' marker state and
|
|
* adjusting opacity. Note that this approach could affect performance
|
|
* with large datasets.
|
|
*/
|
|
inactiveOtherPoints?: boolean;
|
|
/**
|
|
* (Highcharts) When set to `false` will prevent the series data from
|
|
* being included in any form of data export.
|
|
*
|
|
* Since version 6.0.0 until 7.1.0 the option was existing undocumented
|
|
* as `includeInCSVExport`.
|
|
*/
|
|
includeInDataExport?: boolean;
|
|
/**
|
|
* (Highcharts) An array specifying which option maps to which key in
|
|
* the data point array. This makes it convenient to work with
|
|
* unstructured data arrays from different sources.
|
|
*/
|
|
keys?: Array<string>;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) Series labels are placed as close to
|
|
* the series as possible in a natural way, seeking to avoid other
|
|
* series. The goal of this feature is to make the chart more easily
|
|
* readable, like if a human designer placed the labels in the optimal
|
|
* position.
|
|
*
|
|
* The series labels currently work with series types having a `graph`
|
|
* or an `area`.
|
|
*/
|
|
label?: Highcharts.SeriesLabelOptionsObject;
|
|
/**
|
|
* (Highcharts) What type of legend symbol to render for this series.
|
|
* Can be one of `areaMarker`, `lineMarker` or `rectangle`.
|
|
*/
|
|
legendSymbol?: Highcharts.OptionsLegendSymbolValue;
|
|
/**
|
|
* (Highcharts) Set options on specific levels. Takes precedence over
|
|
* series options, but not point options.
|
|
*/
|
|
levels?: Array<Highcharts.PlotTreegraphLevelsOptions>;
|
|
link?: Highcharts.PlotTreegraphLinkOptions;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) The id of another series to link to.
|
|
* Additionally, the value can be ":previous" to link to the previous
|
|
* series. When two 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 have
|
|
* its own sorting definition, the linked series will be sorted in the
|
|
* same order as the master one.
|
|
*/
|
|
linkedTo?: string;
|
|
/**
|
|
* (Highcharts) Options for the point markers of line and scatter-like
|
|
* series. Properties like `fillColor`, `lineColor` and `lineWidth`
|
|
* define the visual appearance of the markers. The `symbol` option
|
|
* defines the shape. Other series types, like column series, don't have
|
|
* markers, but have visual options on the series level instead.
|
|
*
|
|
* In styled mode, the markers can be styled with the
|
|
* `.highcharts-point`, `.highcharts-point-hover` and
|
|
* `.highcharts-point-select` class names.
|
|
*/
|
|
marker?: Highcharts.PointMarkerOptionsObject;
|
|
/**
|
|
* (Highcharts) The distance between nodes in a tree graph in the
|
|
* longitudinal direction. The longitudinal direction means the
|
|
* direction that the chart flows - in a horizontal chart the distance
|
|
* is horizontal, in an inverted chart (vertical), the distance is
|
|
* vertical.
|
|
*
|
|
* If a number is given, it denotes pixels. If a percentage string is
|
|
* given, the distance is a percentage of the rendered node width. A
|
|
* `nodeDistance` of `100%` will render equal widths for the nodes and
|
|
* the gaps between them.
|
|
*
|
|
* This option applies only when the `nodeWidth` option is `auto`,
|
|
* making the node width respond to the number of columns.
|
|
*/
|
|
nodeDistance?: (number|string);
|
|
/**
|
|
* (Highcharts) The pixel width of each node in a, or the height in case
|
|
* the chart is inverted. For tree graphs, the node width is only
|
|
* applied if the marker symbol is `rect`, otherwise the `marker` sizing
|
|
* options apply.
|
|
*
|
|
* Can be a number or a percentage string, or `auto`. If `auto`, the
|
|
* nodes are sized to fill up the plot area in the longitudinal
|
|
* direction, regardless of the number of levels.
|
|
*/
|
|
nodeWidth?: (number|string);
|
|
/**
|
|
* (Highcharts) Options for the _Series on point_ feature. Only `pie`
|
|
* and `sunburst` series are supported at this moment.
|
|
*/
|
|
onPoint?: (object|Highcharts.PlotTreegraphOnPointOptions);
|
|
/**
|
|
* (Highcharts) The opacity of a point in treemap. When a point has
|
|
* children, the visibility of the children is determined by the
|
|
* opacity.
|
|
*/
|
|
opacity?: number;
|
|
/**
|
|
* (Highcharts) Properties for each single point.
|
|
*/
|
|
point?: Highcharts.PlotSeriesPointOptions;
|
|
/**
|
|
* (Highcharts) Same as accessibility.point.descriptionFormat, but for
|
|
* an individual series. Overrides the chart wide configuration.
|
|
*/
|
|
pointDescriptionFormat?: Function;
|
|
/**
|
|
* (Highcharts) Same as accessibility.series.descriptionFormatter, but
|
|
* for an individual series. Overrides the chart wide configuration.
|
|
*/
|
|
pointDescriptionFormatter?: Function;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) If no x values are given for the
|
|
* points in a series, `pointInterval` defines the interval of the x
|
|
* values. For example, if a series contains one value every decade
|
|
* starting from year 0, set `pointInterval` to `10`. In true `datetime`
|
|
* axes, the `pointInterval` is set in milliseconds.
|
|
*
|
|
* It can be also be combined with `pointIntervalUnit` to draw irregular
|
|
* time intervals.
|
|
*
|
|
* If combined with `relativeXValue`, an x value can be set on each
|
|
* point, and the `pointInterval` is added x times to the `pointStart`
|
|
* setting.
|
|
*
|
|
* Please note that this options applies to the _series data_, not the
|
|
* interval of the axis ticks, which is independent.
|
|
*/
|
|
pointInterval?: number;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) On datetime series, this allows for
|
|
* setting the pointInterval to irregular time units, `day`, `month` and
|
|
* `year`. A day is usually the same as 24 hours, but
|
|
* `pointIntervalUnit` also takes the DST crossover into consideration
|
|
* when dealing with local time. Combine this option with
|
|
* `pointInterval` to draw weeks, quarters, 6 months, 10 years etc.
|
|
*
|
|
* Please note that this options applies to the _series data_, not the
|
|
* interval of the axis ticks, which is independent.
|
|
*/
|
|
pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) If no x values are given for the
|
|
* points in a series, pointStart defines on what value to start. For
|
|
* example, if a series contains one yearly value starting from 1945,
|
|
* set pointStart to 1945.
|
|
*
|
|
* If combined with `relativeXValue`, an x value can be set on each
|
|
* point. The x value from the point options is multiplied by
|
|
* `pointInterval` and added to `pointStart` to produce a modified x
|
|
* value.
|
|
*/
|
|
pointStart?: number;
|
|
/**
|
|
* (Highcharts, Highstock) When true, X values in the data set are
|
|
* relative to the current `pointStart`, `pointInterval` and
|
|
* `pointIntervalUnit` settings. This allows compression of the data for
|
|
* datasets with irregular X values.
|
|
*
|
|
* The real X values are computed on the formula `f(x) = ax + b`, where
|
|
* `a` is the `pointInterval` (optionally with a time unit given by
|
|
* `pointIntervalUnit`), and `b` is the `pointStart`.
|
|
*/
|
|
relativeXValue?: boolean;
|
|
/**
|
|
* (Highcharts) Flips the positions of the nodes of a treegraph along
|
|
* the horizontal axis (vertical if chart is inverted).
|
|
*/
|
|
reversed?: boolean;
|
|
/**
|
|
* (Highcharts) Whether to select the series initially. If
|
|
* `showCheckbox` is true, the checkbox next to the series name in the
|
|
* legend will be checked for a selected series.
|
|
*/
|
|
selected?: boolean;
|
|
/**
|
|
* (Highcharts) If true, a checkbox is displayed next to the legend item
|
|
* to allow selecting the series. The state of the checkbox is
|
|
* determined by the `selected` option.
|
|
*/
|
|
showCheckbox?: boolean;
|
|
/**
|
|
* (Highcharts) Whether to display this series type or specific series
|
|
* item in the legend.
|
|
*/
|
|
showInLegend?: boolean;
|
|
/**
|
|
* (Highcharts) If set to `true`, the accessibility module will skip
|
|
* past the points in this series for keyboard navigation.
|
|
*/
|
|
skipKeyboardNavigation?: boolean;
|
|
/**
|
|
* (Highcharts, Highstock) When this is true, the series will not cause
|
|
* the Y axis to cross the zero plane (or threshold option) unless the
|
|
* data actually crosses the plane.
|
|
*
|
|
* For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3
|
|
* will make the Y axis show negative values according to the
|
|
* `minPadding` option. If `softThreshold` is `true`, the Y axis starts
|
|
* at 0.
|
|
*/
|
|
softThreshold?: boolean;
|
|
/**
|
|
* (Highcharts) Sonification/audio chart options for a series.
|
|
*/
|
|
sonification?: Highcharts.SeriesSonificationOptions;
|
|
/**
|
|
* (Highcharts, Highstock) Whether to stack the values of each series on
|
|
* top of each other. Possible values are `undefined` to disable,
|
|
* `"normal"` to stack by value or `"percent"`.
|
|
*
|
|
* When stacking is enabled, data must be sorted in ascending X order.
|
|
*
|
|
* Some stacking options are related to specific series types. In the
|
|
* streamgraph series type, the stacking option is set to `"stream"`.
|
|
* The second one is `"overlap"`, which only applies to waterfall
|
|
* series.
|
|
*/
|
|
stacking?: Highcharts.OptionsStackingValue;
|
|
/**
|
|
* (Highcharts) A wrapper object for all the series options in specific
|
|
* states.
|
|
*/
|
|
states?: Highcharts.SeriesStatesOptionsObject;
|
|
/**
|
|
* (Highcharts, Highstock) Whether to apply steps to the line. Possible
|
|
* values are `left`, `center` and `right`.
|
|
*/
|
|
step?: Highcharts.OptionsStepValue;
|
|
/**
|
|
* (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events.
|
|
* When true, the `mouseOut` event on a series isn't triggered until the
|
|
* mouse moves over another series, or out of the plot area. When false,
|
|
* the `mouseOut` event on a series is triggered when the mouse leaves
|
|
* the area around the series' graph or markers. This also implies the
|
|
* tooltip. When `stickyTracking` is false and `tooltip.shared` is
|
|
* false, the tooltip will be hidden when moving the mouse between
|
|
* series.
|
|
*/
|
|
stickyTracking?: boolean;
|
|
/**
|
|
* (Highcharts, Highstock, Highmaps) A configuration object for the
|
|
* tooltip rendering of each single series. Properties are inherited
|
|
* from tooltip. Overridable properties are `headerFormat`,
|
|
* `pointFormat`, `yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`.
|
|
* Unlike other series, in a scatter plot the series.name by default
|
|
* shows in the headerFormat and point.x and point.y in the pointFormat.
|
|
*/
|
|
tooltip?: Highcharts.SeriesTooltipOptionsObject;
|
|
/**
|
|
* (Highcharts, Highstock, Gantt) When a series contains a data array
|
|
* that is longer than this, only one dimensional arrays of numbers, or
|
|
* two dimensional arrays with x and y values are allowed. Also, only
|
|
* the first point is tested, and the rest are assumed to be the same
|
|
* format. This saves expensive data checking and indexing in long
|
|
* series. Set it to `0` disable.
|
|
*
|
|
* Note: In boost mode turbo threshold is forced. Only array of numbers
|
|
* or two dimensional arrays are allowed.
|
|
*/
|
|
turboThreshold?: number;
|
|
/**
|
|
* (Highcharts) Set the initial visibility of the series.
|
|
*/
|
|
visible?: boolean;
|
|
}
|
|
/**
|
|
* (Highcharts) Enable or disable the initial animation when a series is
|
|
* displayed for the `dataLabels`. The animation can also be set as a
|
|
* configuration object. Please note that this option only applies to the
|
|
* initial animation.
|
|
*
|
|
* 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.
|
|
*/
|
|
interface SeriesTreegraphDataDataLabelsAnimationOptions {
|
|
/**
|
|
* (Highcharts) The animation delay time in milliseconds. Set to `0` to
|
|
* render the data labels immediately. As `undefined` inherits defer
|
|
* time from the series.animation.defer.
|
|
*/
|
|
defer?: number;
|
|
}
|
|
/**
|
|
* (Highcharts) A `treegraph` series. If the type option is not specified,
|
|
* it is inherited from chart.type.
|
|
*
|
|
* In TypeScript the type option must always be set.
|
|
*
|
|
* Configuration options for the series are given in three levels:
|
|
*
|
|
* 1. Options for all series in a chart are defined in the
|
|
* plotOptions.series object.
|
|
*
|
|
* 2. Options for all `treegraph` series are defined in
|
|
* plotOptions.treegraph.
|
|
*
|
|
* 3. Options for one single series are given in the series instance array.
|
|
* (see online documentation for example)
|
|
*
|
|
* You have to extend the `SeriesTreegraphOptions` via an interface to allow
|
|
* custom properties: ``` declare interface SeriesTreegraphOptions {
|
|
* customProperty: string; }
|
|
*
|
|
*/
|
|
interface SeriesTreegraphOptions extends Highcharts.PlotTreegraphOptions, Highcharts.SeriesOptions {
|
|
/**
|
|
* Not available
|
|
*/
|
|
allowDrillToNode?: undefined;
|
|
/**
|
|
* Not available
|
|
*/
|
|
centerInCategory?: undefined;
|
|
/**
|
|
* Not available
|
|
*/
|
|
curveFactor?: undefined;
|
|
/**
|
|
* (Highcharts) An array of data points for the series. For the
|
|
* `treegraph` series type, points can be given in the following ways:
|
|
*
|
|
* 1. The array of arrays, with `keys` property, which defines how the
|
|
* fields in array should be interpreted (see online documentation for
|
|
* example)js data: [{ id: 'Category1' }, { id: 'Category1', parent:
|
|
* 'Category2', }] ```
|
|
*/
|
|
data?: Array<Highcharts.PointOptionsObject>;
|
|
/**
|
|
* Not available
|
|
*/
|
|
layout?: undefined;
|
|
/**
|
|
* Not available
|
|
*/
|
|
nodePadding?: undefined;
|
|
/**
|
|
* Not available
|
|
*/
|
|
stack?: undefined;
|
|
/**
|
|
* Not available
|
|
*/
|
|
traverseUpButton?: undefined;
|
|
/**
|
|
* (Highcharts, Highstock, Highmaps, Gantt) This property is only in
|
|
* TypeScript non-optional and might be `undefined` in series objects
|
|
* from unknown sources.
|
|
*/
|
|
type: "treegraph";
|
|
/**
|
|
* Not available
|
|
*/
|
|
xAxis?: undefined;
|
|
/**
|
|
* Not available
|
|
*/
|
|
yAxis?: undefined;
|
|
}
|
|
}
|