highcharts
Version:
JavaScript charting framework
213 lines (212 loc) • 8.04 kB
TypeScript
/*!*
*
* Copyright (c) Highsoft AS. All rights reserved.
*
*!*/
import * as Highcharts from "../highcharts";
declare module "../highcharts" {
/**
* (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.
*/
interface PlotWordcloudAnimationOptions {
duration?: number;
}
/**
* (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.
*/
interface PlotWordcloudOnPointConnectorOptions {
/**
* (Highcharts) A name for the dash style to use for the connector.
*/
dashstyle?: string;
/**
* (Highcharts) Color of the connector line. By default it's the series'
* color.
*/
stroke?: string;
/**
* (Highcharts) Pixel width of the connector line.
*/
width?: number;
}
/**
* (Highcharts) Options allowing to set a position and an offset of the
* series in the _Series on point_ feature.
*/
interface PlotWordcloudOnPointPositionOptions {
/**
* (Highcharts) Series center offset from the original x position. If
* defined, the connector line is drawn connecting original position
* with new position.
*/
offsetX?: number;
/**
* (Highcharts) Series center offset from the original y position. If
* defined, the connector line is drawn from original position to a new
* position.
*/
offsetY?: number;
/**
* (Highcharts) X position of the series center. By default, the series
* is displayed on the point that it is connected to.
*/
x?: number;
/**
* (Highcharts) Y position of the series center. By default, the series
* is displayed on the point that it is connected to.
*/
y?: number;
}
/**
* (Highcharts) Rotation options for the words in the wordcloud.
*/
interface PlotWordcloudRotationOptions {
/**
* (Highcharts) The smallest degree of rotation for a word.
*/
from?: number;
/**
* (Highcharts) The number of possible orientations for a word, within
* the range of `rotation.from` and `rotation.to`. Must be a number
* larger than 0.
*/
orientations?: number;
/**
* (Highcharts) The largest degree of rotation for a word.
*/
to?: number;
}
/**
* (Highcharts, Highstock) Animation when not hovering over the marker.
*/
interface PlotWordcloudStatesInactiveAnimationOptions {
/**
* (Highcharts, Highstock) The duration of the hover animation in
* milliseconds. By default the hover state animates quickly in, and
* slowly back to normal.
*/
duration?: number;
}
/**
* (Highcharts, Highstock, Gantt) For series on datetime axes, the date
* format in the tooltip's header will by default be guessed based on the
* closest data points. This member gives the default string representations
* used for each unit. For an overview of the string or object
* configuration, see dateFormat.
*/
interface PlotWordcloudTooltipDateTimeLabelFormatsOptions {
day?: string;
hour?: string;
millisecond?: string;
minute?: string;
month?: string;
second?: string;
week?: string;
year?: string;
}
/**
* (Highcharts) Positioning options for fixed tooltip, taking effect only
* when tooltip.fixed is `true`.
*/
interface PlotWordcloudTooltipPositionOptions {
/**
* (Highcharts) The horizontal alignment of the fixed tooltip.
*/
align?: Highcharts.AlignValue;
/**
* (Highcharts) What the fixed tooltip alignment should be relative to.
*
* The default, `pane`, means that it is aligned within the plot area
* for that given series. If the tooltip is split (as default in Stock
* charts), each partial tooltip is aligned within the series' pane.
*/
relativeTo?: Highcharts.OptionsRelativeToValue;
/**
* (Highcharts) The vertical alignment of the fixed tooltip.
*/
verticalAlign?: Highcharts.VerticalAlignValue;
/**
* (Highcharts) X pixel offset from the given position. Can be used to
* shy away from axis lines, grid lines etc to avoid the tooltip
* overlapping other elements.
*/
x?: number;
/**
* (Highcharts) Y pixel offset from the given position. Can be used to
* shy away from axis lines, grid lines etc to avoid the tooltip
* overlapping other elements.
*/
y?: number;
}
/**
* (Highcharts) A `wordcloud` series. If the type option is not specified,
* it is inherited from chart.type.
*
* 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 `wordcloud` series are defined in
* plotOptions.wordcloud.
*
* 3. Options for one single series are given in the series instance array.
* (see online documentation for example)
*
* **TypeScript:**
*
* - type option should always be set, otherwise a broad set of unsupported
* options is allowed.
*
* - when accessing an array of series, the combined set of all series types
* is represented by Highcharts.SeriesOptionsType . Narrowing down to the
* specific type can be done by checking the `type` property. (see online
* documentation for example)
*
* You have to extend the `SeriesWordcloudOptions` via an interface to allow
* custom properties: ``` declare interface SeriesWordcloudOptions {
* customProperty: string; }
*
*/
interface SeriesWordcloudOptions extends Highcharts.PlotWordcloudOptions, Highcharts.SeriesOptions {
/**
* (Highcharts) An array of data points for the series. For the
* `wordcloud` series type, points can be given in the following ways:
*
* 1. An array of arrays with 2 values. In this case, the values
* correspond to `name,weight`. (see online documentation for example)
*
* 2. An array of objects with named values. The following snippet shows
* only a few settings, see the complete options set below. If the total
* number of data points exceeds the series' turboThreshold, this option
* is not available. (see online documentation for example)
*/
data?: Array<([string, number]|Highcharts.PointOptionsObject)>;
/**
* (Highcharts, Highstock, Highmaps, Gantt) This property is only in
* TypeScript non-optional and might be `undefined` in series objects
* from unknown sources.
*/
type: "wordcloud";
}
}