risadmin_prod
/
Icard
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Icard/angular-clarity-master(work.../node_modules/highcharts/options/solidgauge.src.d.ts

719 lines
32 KiB
TypeScript
Raw Normal View History

frontend
2024-07-16 14:55:36 +00:00
/*!*
*
* 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 PlotSolidgaugeAccessibilityPointOptions {
/**
* (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) Data labels for the gauge. For gauges, the data labels are
* enabled by default and shown in a bordered box below the point.
*/
interface PlotSolidgaugeDataLabelsOptions {
/**
* (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.PlotSolidgaugeDataLabelsAnimationOptions|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?: string;
/**
* (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;
}
/**
* (Highcharts) Options for the _Series on point_ feature. Only `pie` and
* `sunburst` series are supported at this moment.
*/
interface PlotSolidgaugeOnPointOptions {
/**
* (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.PlotSolidgaugeOnPointConnectorOptions|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.PlotSolidgaugeOnPointPositionOptions);
}
/**
* (Highcharts) A solid gauge is a circular gauge where the value is
* indicated by a filled arc, and the color of the arc may variate with the
* value.
*
* 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 `solidgauge` series are defined in
* plotOptions.solidgauge.
*
* 3. Options for one single series are given in the series instance array.
* (see online documentation for example)
*/
interface PlotSolidgaugeOptions {
/**
* (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) 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) 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) Whether to give each point an individual color.
*/
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, 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) 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) Data labels for the gauge. For gauges, the data labels
* are enabled by default and shown in a bordered box below the point.
*/
dataLabels?: (Highcharts.PlotSolidgaugeDataLabelsOptions|Array<Highcharts.PlotSolidgaugeDataLabelsOptions>);
/**
* (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) 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) The inner radius for points in a solid gauge. Can be
* given only in percentage, either as a number or a string like
* `"50%"`.
*/
innerRadius?: string;
/**
* (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) Whether the strokes of the solid gauge should be `round`
* or `square`.
*/
linecap?: Highcharts.OptionsLinecapValue;
/**
* (Highcharts, Highstock) Pixel width of the graph line.
*/
lineWidth?: number;
/**
* (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 _Series on point_ feature. Only `pie`
* and `sunburst` series are supported at this moment.
*/
onPoint?: (object|Highcharts.PlotSolidgaugeOnPointOptions);
/**
* (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
* dataLabels.
*/
opacity?: number;
/**
* (Highcharts) Allow the gauge to overshoot the end of the perimeter
* axis by this many degrees. Say if the gauge axis goes from 0 to 60, a
* value of 100, or 1000, will show 5 degrees beyond the end of the axis
* when this option is set to 5.
*/
overshoot?: 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) The outer radius for points in a solid gauge. Can be
* given only in percentage, either as a number or a string like
* `"100%"`.
*/
radius?: string;
/**
* (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) Whether to draw rounded edges on the gauge. This options
* adds the radius of the rounding to the ends of the arc, so it extends
* past the actual values. When `borderRadius` is set, it takes
* precedence over `rounded`. A `borderRadius` of 50% behaves like
* `rounded`, except the shape is not extended past its value.
*/
rounded?: 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 particular series or series type
* in the legend. Defaults to false for gauge series.
*/
showInLegend?: boolean;
/**
* (Highcharts) If set to `true`, the accessibility module will skip
* past the points in this series for keyboard navigation.
*/
skipKeyboardNavigation?: boolean;
/**
* (Highcharts) Sonification/audio chart options for a series.
*/
sonification?: Highcharts.SeriesSonificationOptions;
/**
* (Highcharts) 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 not shared. When `stickyTracking` is false and
* `tooltip.shared` is false, the tooltip will be hidden when moving the
* mouse between series. Defaults to true for line and area type series,
* but to false for columns, pies etc.
*
* **Note:** The boost module will force this option because of
* technical limitations.
*/
stickyTracking?: boolean;
/**
* (Highcharts) The threshold or base level for the gauge.
*/
threshold?: (number|null);
/**
* (Highcharts) A configuration object for the tooltip rendering of each
* single series. Properties are inherited from tooltip, but only the
* following properties can be defined on a series level.
*/
tooltip?: Highcharts.SeriesTooltipOptionsObject;
/**
* (Highcharts) Set the initial visibility of the series.
*/
visible?: boolean;
}
/**
* (Highcharts, Highstock, 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 SeriesSolidgaugeDataDataLabelsAnimationOptions {
/**
* (Highcharts, Highstock, 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;
}
}