highcharts 13.0.2 → 13.1.0

package/options/networkgraph.d.ts

@@ -82,6 +82,25 @@ declare module "../highcharts" {
          */
         valueSuffix?: string;
     }
+    /**
+     * (Highcharts, Highstock, Highmaps, Gantt) 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 PlotNetworkgraphDataLabelsAnimationOptions {
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) 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, Highstock, Highmaps, Gantt) Styles for the label. The
      * default `color` setting is `"contrast"`, which is a pseudo color that
@@ -111,6 +130,121 @@ declare module "../highcharts" {
     interface PlotNetworkgraphDataLabelsStyleOptions {
         transition?: string;
     }
+    interface PlotNetworkgraphLayoutAlgorithmOptions {
+        /**
+         * (Highcharts) Approximation used to calculate repulsive forces
+         * affecting nodes. By default, when calculating net force, nodes are
+         * compared against each other, which gives O(N^2) complexity. Using
+         * Barnes-Hut approximation, we decrease this to O(N log N), but the
+         * resulting graph will have different layout. Barnes-Hut approximation
+         * divides space into rectangles via quad tree, where forces exerted on
+         * nodes are calculated directly for nearby cells, and for all others,
+         * cells are treated as a separate node with center of mass.
+         */
+        approximation?: Highcharts.OptionsApproximationValue;
+        /**
+         * (Highcharts) Attraction force applied on a node which is connected to
+         * another node by a link. Passed are two arguments:
+         *
+         * - `d` - which is current distance between two nodes
+         *
+         * - `k` - which is desired distance between two nodes
+         *
+         * In `verlet` integration, defaults to: `function (d, k) { return (k -
+         * d) / d; }`
+         */
+        attractiveForce?: Function;
+        /**
+         * (Highcharts) Experimental. Enables live simulation of the algorithm
+         * implementation. All nodes are animated as the forces applies on them.
+         */
+        enableSimulation?: boolean;
+        /**
+         * (Highcharts) Friction applied on forces to prevent nodes rushing to
+         * fast to the desired positions.
+         */
+        friction?: number;
+        /**
+         * (Highcharts) Gravitational const used in the barycenter force of the
+         * algorithm.
+         */
+        gravitationalConstant?: number;
+        /**
+         * (Highcharts) When `initialPositions` are set to 'circle',
+         * `initialPositionRadius` is a distance from the center of circle, in
+         * which nodes are created.
+         */
+        initialPositionRadius?: number;
+        /**
+         * (Highcharts) Initial layout algorithm for positioning nodes. Can be
+         * one of built-in options ("circle", "random") or a function where
+         * positions should be set on each node (`this.nodes`) as `node.plotX`
+         * and `node.plotY`
+         */
+        initialPositions?: ("circle"|"random"|Function);
+        /**
+         * (Highcharts) Integration type. Available options are `'euler'` and
+         * `'verlet'`. Integration determines how forces are applied on
+         * particles. In Euler integration, force is applied direct as
+         * `newPosition += velocity;`. In Verlet integration, new position is
+         * based on a previous position without velocity: `newPosition +=
+         * previousPosition - newPosition`.
+         *
+         * Note that different integrations give different results as forces are
+         * different.
+         *
+         * In Highcharts v7.0.x only `'euler'` integration was supported.
+         */
+        integration?: Highcharts.OptionsIntegrationValue;
+        /**
+         * (Highcharts) Ideal length (px) of the link between two nodes. When
+         * not defined, length is calculated as: `Math.pow(availableWidth *
+         * availableHeight / nodesLength, 0.4);`
+         *
+         * Note: Because of the algorithm specification, length of each link
+         * might be not exactly as specified.
+         */
+        linkLength?: number;
+        /**
+         * (Highcharts) Max number of iterations before algorithm will stop. In
+         * general, algorithm should find positions sooner, but when rendering
+         * huge number of nodes, it is recommended to increase this value as
+         * finding perfect graph positions can require more time.
+         */
+        maxIterations?: number;
+        /**
+         * (Highcharts) Verlet integration only. Max speed that node can get in
+         * one iteration. In terms of simulation, it's a maximum translation (in
+         * pixels) that node can move (in both, x and y, dimensions). While
+         * `friction` is applied on all nodes, max speed is applied only for
+         * nodes that move very fast, for example small or disconnected ones.
+         */
+        maxSpeed?: number;
+        /**
+         * (Highcharts) Repulsive force applied on a node. Passed are two
+         * arguments:
+         *
+         * - `d` - which is current distance between two nodes
+         *
+         * - `k` - which is desired distance between two nodes
+         *
+         * In `verlet` integration, defaults to: `function (d, k) { return (k -
+         * d) / d * (k > d ? 1 : 0) }`
+         */
+        repulsiveForce?: Function;
+        /**
+         * (Highcharts) Barnes-Hut approximation only. Determines when distance
+         * between cell and node is small enough to calculate forces. Value of
+         * `theta` is compared directly with quotient `s / d`, where `s` is the
+         * size of the cell, and `d` is distance between center of cell's mass
+         * and currently compared node.
+         */
+        theta?: number;
+        /**
+         * (Highcharts) Type of the algorithm used when positioning nodes.
+         */
+        type?: "reingold-fruchterman";
+    }
     /**
      * (Highcharts) Link style options
      */
@@ -132,12 +266,39 @@ declare module "../highcharts" {
          */
         width?: number;
     }
+    /**
+     * (Highcharts) Animation when hovering over the marker.
+     */
+    interface PlotNetworkgraphMarkerStatesHoverAnimationOptions {
+        duration?: number;
+    }
     /**
      * (Highcharts) Animation when hovering over the marker.
      */
     interface PlotNetworkgraphMarkerStatesSelectAnimationOptions {
         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 PlotNetworkgraphOnPointConnectorOptions {
+        /**
+         * (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 for the _Series on point_ feature. Only `pie` and
      * `sunburst` series are supported at this moment.
@@ -163,6 +324,34 @@ declare module "../highcharts" {
          */
         position?: (object|Highcharts.PlotNetworkgraphOnPointPositionOptions);
     }
+    /**
+     * (Highcharts) Options allowing to set a position and an offset of the
+     * series in the _Series on point_ feature.
+     */
+    interface PlotNetworkgraphOnPointPositionOptions {
+        /**
+         * (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) A networkgraph is a type of relationship chart, where
      * connections (links) attracts nodes (points) and other nodes repulse each
@@ -636,6 +825,18 @@ declare module "../highcharts" {
          */
         zoomEnabled?: boolean;
     }
+    /**
+     * (Highcharts, Highstock) Animation setting for hovering the graph in
+     * line-type series.
+     */
+    interface PlotNetworkgraphStatesHoverAnimationOptions {
+        /**
+         * (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) Animation when not hovering over the node.
      */
@@ -647,6 +848,27 @@ declare module "../highcharts" {
          */
         duration?: number;
     }
+    /**
+     * (Highcharts) Link style options
+     */
+    interface PlotNetworkgraphStatesInactiveLinkOptions {
+        /**
+         * (Highcharts) Color of the link between two nodes.
+         */
+        color?: string;
+        /**
+         * (Highcharts) A name for the dash style to use for links.
+         */
+        dashStyle?: string;
+        /**
+         * (Highcharts) Opacity of the link between two nodes.
+         */
+        opacity?: number;
+        /**
+         * (Highcharts) Width (px) of the link between two nodes.
+         */
+        width?: number;
+    }
     /**
      * (Highcharts, Highstock) Animation setting for hovering the graph in
      * line-type series.
@@ -659,6 +881,23 @@ declare module "../highcharts" {
          */
         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 PlotNetworkgraphTooltipDateTimeLabelFormatsOptions {
+        day?: string;
+        hour?: string;
+        millisecond?: string;
+        minute?: string;
+        month?: string;
+        second?: string;
+        week?: string;
+        year?: string;
+    }
     /**
      * (Highcharts) Options for the tooltip header when tooltip.split is
      * enabled. The header is the box containing the X value in a split tooltip.
@@ -701,12 +940,71 @@ declare module "../highcharts" {
          */
         style?: object;
     }
+    /**
+     * (Highcharts) Positioning options for fixed tooltip, taking effect only
+     * when tooltip.fixed is `true`.
+     */
+    interface PlotNetworkgraphTooltipPositionOptions {
+        /**
+         * (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) 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 SeriesNetworkgraphDataDataLabelsAnimationOptions {
+        /**
+         * (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) Animation when hovering over the marker.
      */
     interface SeriesNetworkgraphNodesMarkerStatesHoverAnimationOptions {
         duration?: number;
     }
+    /**
+     * (Highcharts) Animation when hovering over the marker.
+     */
+    interface SeriesNetworkgraphNodesMarkerStatesSelectAnimationOptions {
+        duration?: number;
+    }
     /**
      * (Highcharts) A collection of options for the individual nodes. The nodes
      * in a networkgraph diagram are auto-generated instances of
@@ -756,4 +1054,71 @@ declare module "../highcharts" {
          */
         name?: string;
     }
+    /**
+     * (Highcharts) A `networkgraph` 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 `networkgraph` series are defined in
+     * plotOptions.networkgraph.
+     *
+     * 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 `SeriesNetworkgraphOptions` via an interface to
+     * allow custom properties: ``` declare interface SeriesNetworkgraphOptions
+     * { customProperty: string; }
+     *
+     */
+    interface SeriesNetworkgraphOptions extends Highcharts.PlotNetworkgraphOptions, Highcharts.SeriesOptions {
+        /**
+         * (Highcharts) An array of data points for the series. For the
+         * `networkgraph` series type, points can be given in the following way:
+         *
+         * 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?: (Highcharts.PointOptionsObject|Array<(object|any[]|number)>);
+        /**
+         * (Highcharts) A collection of options for the individual nodes. The
+         * nodes in a networkgraph diagram are auto-generated instances of
+         * `Highcharts.Point`, but options can be applied here and linked by the
+         * `id`.
+         */
+        nodes?: Array<Highcharts.SeriesNetworkgraphNodesOptions>;
+        /**
+         * Not available
+         */
+        stack?: undefined;
+        /**
+         * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
+         * TypeScript non-optional and might be `undefined` in series objects
+         * from unknown sources.
+         */
+        type: "networkgraph";
+        /**
+         * Not available
+         */
+        xAxis?: undefined;
+        /**
+         * Not available
+         */
+        yAxis?: undefined;
+    }
 }