com.github.fluorumlabs.disconnect.highcharts.ChartOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
package com.github.fluorumlabs.disconnect.highcharts;
import js.extras.JsEnum;
import js.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;
import org.teavm.jso.JSProperty;
import javax.annotation.Nullable;
/**
* (Highcharts, Highstock, Highmaps) General options for the chart.
*
* @see https://api.highcharts.com/highcharts/chart
* @see https://api.highcharts.com/highstock/chart
* @see https://api.highcharts.com/highmaps/chart
*
*/
public interface ChartOptions extends Any {
/**
* (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
* or more opposite axes will automatically be aligned by adding ticks to
* the axis or axes with the least ticks, as if tickAmount were specified.
*
* This can be prevented by setting alignTicks to false. If the grid lines
* look messy, it's a good idea to hide them for the secondary axis by
* setting gridLineWidth to 0.
*
* If startOnTick or endOnTick in an Axis options are set to false, then
* the alignTicks will be disabled for the Axis.
*
* Disabled for logarithmic axes.
*
* @see https://api.highcharts.com/highcharts/chart.alignTicks
* @see https://api.highcharts.com/highstock/chart.alignTicks
* @see https://api.highcharts.com/gantt/chart.alignTicks
*
* @implspec alignTicks?: boolean;
*
*/
@JSProperty("alignTicks")
boolean getAlignTicks();
/**
* (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
* or more opposite axes will automatically be aligned by adding ticks to
* the axis or axes with the least ticks, as if tickAmount were specified.
*
* This can be prevented by setting alignTicks to false. If the grid lines
* look messy, it's a good idea to hide them for the secondary axis by
* setting gridLineWidth to 0.
*
* If startOnTick or endOnTick in an Axis options are set to false, then
* the alignTicks will be disabled for the Axis.
*
* Disabled for logarithmic axes.
*
* @see https://api.highcharts.com/highcharts/chart.alignTicks
* @see https://api.highcharts.com/highstock/chart.alignTicks
* @see https://api.highcharts.com/gantt/chart.alignTicks
*
* @implspec alignTicks?: boolean;
*
*/
@JSProperty("alignTicks")
void setAlignTicks(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Set the overall animation for all chart
* updating. Animation can be disabled throughout the chart by setting it to
* false here. It can be overridden for each individual API method as a
* function parameter. The only animation not affected by this option is the
* initial series animation, see plotOptions.series.animation.
*
* The animation can either be set as a boolean or a configuration object.
* If true, it will use the 'swing' jQuery easing and a duration of 500
* ms. If used as a configuration object, the following properties are
* supported:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.animation
* @see https://api.highcharts.com/highstock/chart.animation
* @see https://api.highcharts.com/highmaps/chart.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject);
*
*/
@JSProperty("animation")
@Nullable
Unknown getAnimation();
/**
* (Highcharts, Highstock, Highmaps) Set the overall animation for all chart
* updating. Animation can be disabled throughout the chart by setting it to
* false here. It can be overridden for each individual API method as a
* function parameter. The only animation not affected by this option is the
* initial series animation, see plotOptions.series.animation.
*
* The animation can either be set as a boolean or a configuration object.
* If true, it will use the 'swing' jQuery easing and a duration of 500
* ms. If used as a configuration object, the following properties are
* supported:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.animation
* @see https://api.highcharts.com/highstock/chart.animation
* @see https://api.highcharts.com/highmaps/chart.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject);
*
*/
@JSProperty("animation")
void setAnimation(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Set the overall animation for all chart
* updating. Animation can be disabled throughout the chart by setting it to
* false here. It can be overridden for each individual API method as a
* function parameter. The only animation not affected by this option is the
* initial series animation, see plotOptions.series.animation.
*
* The animation can either be set as a boolean or a configuration object.
* If true, it will use the 'swing' jQuery easing and a duration of 500
* ms. If used as a configuration object, the following properties are
* supported:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.animation
* @see https://api.highcharts.com/highstock/chart.animation
* @see https://api.highcharts.com/highmaps/chart.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject);
*
*/
@JSProperty("animation")
void setAnimation(AnimationOptionsObject value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the outer chart area.
*
* @see https://api.highcharts.com/highcharts/chart.backgroundColor
* @see https://api.highcharts.com/highstock/chart.backgroundColor
* @see https://api.highcharts.com/highmaps/chart.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
@Nullable
Unknown getBackgroundColor();
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the outer chart area.
*
* @see https://api.highcharts.com/highcharts/chart.backgroundColor
* @see https://api.highcharts.com/highstock/chart.backgroundColor
* @see https://api.highcharts.com/highmaps/chart.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(GradientColorObject value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the outer chart area.
*
* @see https://api.highcharts.com/highcharts/chart.backgroundColor
* @see https://api.highcharts.com/highstock/chart.backgroundColor
* @see https://api.highcharts.com/highmaps/chart.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the outer chart area.
*
* @see https://api.highcharts.com/highcharts/chart.backgroundColor
* @see https://api.highcharts.com/highstock/chart.backgroundColor
* @see https://api.highcharts.com/highmaps/chart.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(Any value);
/**
* (Highcharts, Highstock, Highmaps) The color of the outer chart border.
*
* @see https://api.highcharts.com/highcharts/chart.borderColor
* @see https://api.highcharts.com/highstock/chart.borderColor
* @see https://api.highcharts.com/highmaps/chart.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
@Nullable
String getBorderColor();
/**
* (Highcharts, Highstock, Highmaps) The color of the outer chart border.
*
* @see https://api.highcharts.com/highcharts/chart.borderColor
* @see https://api.highcharts.com/highstock/chart.borderColor
* @see https://api.highcharts.com/highmaps/chart.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
void setBorderColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The corner radius of the outer chart
* border.
*
* @see https://api.highcharts.com/highcharts/chart.borderRadius
* @see https://api.highcharts.com/highstock/chart.borderRadius
* @see https://api.highcharts.com/highmaps/chart.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
double getBorderRadius();
/**
* (Highcharts, Highstock, Highmaps) The corner radius of the outer chart
* border.
*
* @see https://api.highcharts.com/highcharts/chart.borderRadius
* @see https://api.highcharts.com/highstock/chart.borderRadius
* @see https://api.highcharts.com/highmaps/chart.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
void setBorderRadius(double value);
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the outer chart
* border.
*
* @see https://api.highcharts.com/highcharts/chart.borderWidth
* @see https://api.highcharts.com/highstock/chart.borderWidth
* @see https://api.highcharts.com/highmaps/chart.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
double getBorderWidth();
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the outer chart
* border.
*
* @see https://api.highcharts.com/highcharts/chart.borderWidth
* @see https://api.highcharts.com/highstock/chart.borderWidth
* @see https://api.highcharts.com/highmaps/chart.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
void setBorderWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) A CSS class name to apply to the charts
* container div, allowing unique CSS styling for each chart.
*
* @see https://api.highcharts.com/highcharts/chart.className
* @see https://api.highcharts.com/highstock/chart.className
* @see https://api.highcharts.com/highmaps/chart.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highcharts, Highstock, Highmaps) A CSS class name to apply to the charts
* container div, allowing unique CSS styling for each chart.
*
* @see https://api.highcharts.com/highcharts/chart.className
* @see https://api.highcharts.com/highstock/chart.className
* @see https://api.highcharts.com/highmaps/chart.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highcharts, Highstock, Highmaps) In styled mode, this sets how many
* colors the class names should rotate between. With ten colors, series (or
* points) are given class names like highcharts-color-0,
* highcharts-color-0 [...] highcharts-color-9. The equivalent in
* non-styled mode is to set colors using the colors setting.
*
* @see https://api.highcharts.com/highcharts/chart.colorCount
* @see https://api.highcharts.com/highstock/chart.colorCount
* @see https://api.highcharts.com/highmaps/chart.colorCount
*
* @implspec colorCount?: number;
*
*/
@JSProperty("colorCount")
double getColorCount();
/**
* (Highcharts, Highstock, Highmaps) In styled mode, this sets how many
* colors the class names should rotate between. With ten colors, series (or
* points) are given class names like highcharts-color-0,
* highcharts-color-0 [...] highcharts-color-9. The equivalent in
* non-styled mode is to set colors using the colors setting.
*
* @see https://api.highcharts.com/highcharts/chart.colorCount
* @see https://api.highcharts.com/highstock/chart.colorCount
* @see https://api.highcharts.com/highmaps/chart.colorCount
*
* @implspec colorCount?: number;
*
*/
@JSProperty("colorCount")
void setColorCount(double value);
/**
* (Highcharts) Alias of type.
*
* @see https://api.highcharts.com/highcharts/chart.defaultSeriesType
*
* @implspec defaultSeriesType?: string;
*
*/
@JSProperty("defaultSeriesType")
@Nullable
String getDefaultSeriesType();
/**
* (Highcharts) Alias of type.
*
* @see https://api.highcharts.com/highcharts/chart.defaultSeriesType
*
* @implspec defaultSeriesType?: string;
*
*/
@JSProperty("defaultSeriesType")
void setDefaultSeriesType(String value);
/**
* (Highcharts, Highstock, Highmaps) A text description of the chart.
*
* If the Accessibility module is loaded, this is included by default as a
* long description of the chart and its contents in the hidden screen
* reader information region.
*
* @see https://api.highcharts.com/highcharts/chart.description
* @see https://api.highcharts.com/highstock/chart.description
* @see https://api.highcharts.com/highmaps/chart.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
@Nullable
String getDescription();
/**
* (Highcharts, Highstock, Highmaps) A text description of the chart.
*
* If the Accessibility module is loaded, this is included by default as a
* long description of the chart and its contents in the hidden screen
* reader information region.
*
* @see https://api.highcharts.com/highcharts/chart.description
* @see https://api.highcharts.com/highstock/chart.description
* @see https://api.highcharts.com/highmaps/chart.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
void setDescription(String value);
/**
* (Highcharts, Highstock, Highmaps) Event listeners for the chart.
*
* @see https://api.highcharts.com/highcharts/chart.events
* @see https://api.highcharts.com/highstock/chart.events
* @see https://api.highcharts.com/highmaps/chart.events
*
* @implspec events?: ChartEventsOptions;
*
*/
@JSProperty("events")
@Nullable
ChartEventsOptions getEvents();
/**
* (Highcharts, Highstock, Highmaps) Event listeners for the chart.
*
* @see https://api.highcharts.com/highcharts/chart.events
* @see https://api.highcharts.com/highstock/chart.events
* @see https://api.highcharts.com/highmaps/chart.events
*
* @implspec events?: ChartEventsOptions;
*
*/
@JSProperty("events")
void setEvents(ChartEventsOptions value);
/**
* (Highcharts, Highstock, Highmaps) An explicit height for the chart. If a
* number, the height is given in pixels. If given a percentage string
* (for example '56%'), the height is given as the percentage of the
* actual chart width. This allows for preserving the aspect ratio across
* responsive sizes.
*
* By default (when null) the height is calculated from the offset height
* of the containing element, or 400 pixels if the containing element's
* height is 0.
*
* @see https://api.highcharts.com/highcharts/chart.height
* @see https://api.highcharts.com/highstock/chart.height
* @see https://api.highcharts.com/highmaps/chart.height
*
* @implspec height?: (number|string|null);
*
*/
@JSProperty("height")
@Nullable
Unknown getHeight();
/**
* (Highcharts, Highstock, Highmaps) An explicit height for the chart. If a
* number, the height is given in pixels. If given a percentage string
* (for example '56%'), the height is given as the percentage of the
* actual chart width. This allows for preserving the aspect ratio across
* responsive sizes.
*
* By default (when null) the height is calculated from the offset height
* of the containing element, or 400 pixels if the containing element's
* height is 0.
*
* @see https://api.highcharts.com/highcharts/chart.height
* @see https://api.highcharts.com/highstock/chart.height
* @see https://api.highcharts.com/highmaps/chart.height
*
* @implspec height?: (number|string|null);
*
*/
@JSProperty("height")
void setHeight(double value);
/**
* (Highcharts, Highstock, Highmaps) An explicit height for the chart. If a
* number, the height is given in pixels. If given a percentage string
* (for example '56%'), the height is given as the percentage of the
* actual chart width. This allows for preserving the aspect ratio across
* responsive sizes.
*
* By default (when null) the height is calculated from the offset height
* of the containing element, or 400 pixels if the containing element's
* height is 0.
*
* @see https://api.highcharts.com/highcharts/chart.height
* @see https://api.highcharts.com/highstock/chart.height
* @see https://api.highcharts.com/highmaps/chart.height
*
* @implspec height?: (number|string|null);
*
*/
@JSProperty("height")
void setHeight(String value);
/**
* (Highcharts, Highstock, Gantt) If true, the axes will scale to the
* remaining visible series once one series is hidden. If false, hiding and
* showing a series will not affect the axes or the other series. For
* stacks, once one series within the stack is hidden, the rest of the stack
* will close in around it even if the axis is not affected.
*
* @see https://api.highcharts.com/highcharts/chart.ignoreHiddenSeries
* @see https://api.highcharts.com/highstock/chart.ignoreHiddenSeries
* @see https://api.highcharts.com/gantt/chart.ignoreHiddenSeries
*
* @implspec ignoreHiddenSeries?: boolean;
*
*/
@JSProperty("ignoreHiddenSeries")
boolean getIgnoreHiddenSeries();
/**
* (Highcharts, Highstock, Gantt) If true, the axes will scale to the
* remaining visible series once one series is hidden. If false, hiding and
* showing a series will not affect the axes or the other series. For
* stacks, once one series within the stack is hidden, the rest of the stack
* will close in around it even if the axis is not affected.
*
* @see https://api.highcharts.com/highcharts/chart.ignoreHiddenSeries
* @see https://api.highcharts.com/highstock/chart.ignoreHiddenSeries
* @see https://api.highcharts.com/gantt/chart.ignoreHiddenSeries
*
* @implspec ignoreHiddenSeries?: boolean;
*
*/
@JSProperty("ignoreHiddenSeries")
void setIgnoreHiddenSeries(boolean value);
/**
* (Highcharts, Highstock, Gantt) Whether to invert the axes so that the x
* axis is vertical and y axis is horizontal. When true, the x axis is
* reversed by default.
*
* @see https://api.highcharts.com/highcharts/chart.inverted
* @see https://api.highcharts.com/highstock/chart.inverted
* @see https://api.highcharts.com/gantt/chart.inverted
*
* @implspec inverted?: boolean;
*
*/
@JSProperty("inverted")
boolean getInverted();
/**
* (Highcharts, Highstock, Gantt) Whether to invert the axes so that the x
* axis is vertical and y axis is horizontal. When true, the x axis is
* reversed by default.
*
* @see https://api.highcharts.com/highcharts/chart.inverted
* @see https://api.highcharts.com/highstock/chart.inverted
* @see https://api.highcharts.com/gantt/chart.inverted
*
* @implspec inverted?: boolean;
*
*/
@JSProperty("inverted")
void setInverted(boolean value);
/**
* (Highmaps) Default mapData for all series. If set to a string, it
* functions as an index into the Highcharts.maps array. Otherwise it is
* interpreted s map data.
*
* @see https://api.highcharts.com/highmaps/chart.map
*
* @implspec map?: (string|Array);
*
*/
@JSProperty("map")
@Nullable
Unknown getMap();
/**
* (Highmaps) Default mapData for all series. If set to a string, it
* functions as an index into the Highcharts.maps array. Otherwise it is
* interpreted s map data.
*
* @see https://api.highcharts.com/highmaps/chart.map
*
* @implspec map?: (string|Array);
*
*/
@JSProperty("map")
void setMap(Array value);
/**
* (Highmaps) Default mapData for all series. If set to a string, it
* functions as an index into the Highcharts.maps array. Otherwise it is
* interpreted s map data.
*
* @see https://api.highcharts.com/highmaps/chart.map
*
* @implspec map?: (string|Array);
*
*/
@JSProperty("map")
void setMap(String value);
/**
* (Highmaps) Set lat/lon transformation definitions for the chart. If not
* defined, these are extracted from the map data.
*
* @see https://api.highcharts.com/highmaps/chart.mapTransforms
*
* @implspec mapTransforms?: any;
*
*/
@JSProperty("mapTransforms")
@Nullable
Any getMapTransforms();
/**
* (Highmaps) Set lat/lon transformation definitions for the chart. If not
* defined, these are extracted from the map data.
*
* @see https://api.highcharts.com/highmaps/chart.mapTransforms
*
* @implspec mapTransforms?: any;
*
*/
@JSProperty("mapTransforms")
void setMapTransforms(Any value);
/**
* (Highcharts, Highstock, Highmaps) The margin between the outer edge of
* the chart and the plot area. The numbers in the array designate top,
* right, bottom and left respectively. Use the options marginTop,
* marginRight, marginBottom and marginLeft for shorthand setting of
* one option.
*
* By default there is no margin. The actual space is dynamically calculated
* from the offset of axis labels, axis title, title, subtitle and legend in
* addition to the spacingTop, spacingRight, spacingBottom and
* spacingLeft options.
*
* @see https://api.highcharts.com/highcharts/chart.margin
* @see https://api.highcharts.com/highstock/chart.margin
* @see https://api.highcharts.com/highmaps/chart.margin
*
* @implspec margin?: (number|Array);
*
*/
@JSProperty("margin")
@Nullable
Unknown getMargin();
/**
* (Highcharts, Highstock, Highmaps) The margin between the outer edge of
* the chart and the plot area. The numbers in the array designate top,
* right, bottom and left respectively. Use the options marginTop,
* marginRight, marginBottom and marginLeft for shorthand setting of
* one option.
*
* By default there is no margin. The actual space is dynamically calculated
* from the offset of axis labels, axis title, title, subtitle and legend in
* addition to the spacingTop, spacingRight, spacingBottom and
* spacingLeft options.
*
* @see https://api.highcharts.com/highcharts/chart.margin
* @see https://api.highcharts.com/highstock/chart.margin
* @see https://api.highcharts.com/highmaps/chart.margin
*
* @implspec margin?: (number|Array);
*
*/
@JSProperty("margin")
void setMargin(double[] value);
/**
* (Highcharts, Highstock, Highmaps) The margin between the outer edge of
* the chart and the plot area. The numbers in the array designate top,
* right, bottom and left respectively. Use the options marginTop,
* marginRight, marginBottom and marginLeft for shorthand setting of
* one option.
*
* By default there is no margin. The actual space is dynamically calculated
* from the offset of axis labels, axis title, title, subtitle and legend in
* addition to the spacingTop, spacingRight, spacingBottom and
* spacingLeft options.
*
* @see https://api.highcharts.com/highcharts/chart.margin
* @see https://api.highcharts.com/highstock/chart.margin
* @see https://api.highcharts.com/highmaps/chart.margin
*
* @implspec margin?: (number|Array);
*
*/
@JSProperty("margin")
void setMargin(double value);
/**
* (Highcharts, Highstock, Highmaps) The margin between the bottom outer
* edge of the chart and the plot area. Use this to set a fixed pixel value
* for the margin as opposed to the default dynamic margin. See also
* spacingBottom.
*
* @see https://api.highcharts.com/highcharts/chart.marginBottom
* @see https://api.highcharts.com/highstock/chart.marginBottom
* @see https://api.highcharts.com/highmaps/chart.marginBottom
*
* @implspec marginBottom?: number;
*
*/
@JSProperty("marginBottom")
double getMarginBottom();
/**
* (Highcharts, Highstock, Highmaps) The margin between the bottom outer
* edge of the chart and the plot area. Use this to set a fixed pixel value
* for the margin as opposed to the default dynamic margin. See also
* spacingBottom.
*
* @see https://api.highcharts.com/highcharts/chart.marginBottom
* @see https://api.highcharts.com/highstock/chart.marginBottom
* @see https://api.highcharts.com/highmaps/chart.marginBottom
*
* @implspec marginBottom?: number;
*
*/
@JSProperty("marginBottom")
void setMarginBottom(double value);
/**
* (Highcharts, Highstock, Highmaps) The margin between the left outer edge
* of the chart and the plot area. Use this to set a fixed pixel value for
* the margin as opposed to the default dynamic margin. See also
* spacingLeft.
*
* @see https://api.highcharts.com/highcharts/chart.marginLeft
* @see https://api.highcharts.com/highstock/chart.marginLeft
* @see https://api.highcharts.com/highmaps/chart.marginLeft
*
* @implspec marginLeft?: number;
*
*/
@JSProperty("marginLeft")
double getMarginLeft();
/**
* (Highcharts, Highstock, Highmaps) The margin between the left outer edge
* of the chart and the plot area. Use this to set a fixed pixel value for
* the margin as opposed to the default dynamic margin. See also
* spacingLeft.
*
* @see https://api.highcharts.com/highcharts/chart.marginLeft
* @see https://api.highcharts.com/highstock/chart.marginLeft
* @see https://api.highcharts.com/highmaps/chart.marginLeft
*
* @implspec marginLeft?: number;
*
*/
@JSProperty("marginLeft")
void setMarginLeft(double value);
/**
* (Highcharts, Highstock, Highmaps) The margin between the right outer edge
* of the chart and the plot area. Use this to set a fixed pixel value for
* the margin as opposed to the default dynamic margin. See also
* spacingRight.
*
* @see https://api.highcharts.com/highcharts/chart.marginRight
* @see https://api.highcharts.com/highstock/chart.marginRight
* @see https://api.highcharts.com/highmaps/chart.marginRight
*
* @implspec marginRight?: number;
*
*/
@JSProperty("marginRight")
double getMarginRight();
/**
* (Highcharts, Highstock, Highmaps) The margin between the right outer edge
* of the chart and the plot area. Use this to set a fixed pixel value for
* the margin as opposed to the default dynamic margin. See also
* spacingRight.
*
* @see https://api.highcharts.com/highcharts/chart.marginRight
* @see https://api.highcharts.com/highstock/chart.marginRight
* @see https://api.highcharts.com/highmaps/chart.marginRight
*
* @implspec marginRight?: number;
*
*/
@JSProperty("marginRight")
void setMarginRight(double value);
/**
* (Highcharts, Highstock, Highmaps) The margin between the top outer edge
* of the chart and the plot area. Use this to set a fixed pixel value for
* the margin as opposed to the default dynamic margin. See also
* spacingTop.
*
* @see https://api.highcharts.com/highcharts/chart.marginTop
* @see https://api.highcharts.com/highstock/chart.marginTop
* @see https://api.highcharts.com/highmaps/chart.marginTop
*
* @implspec marginTop?: number;
*
*/
@JSProperty("marginTop")
double getMarginTop();
/**
* (Highcharts, Highstock, Highmaps) The margin between the top outer edge
* of the chart and the plot area. Use this to set a fixed pixel value for
* the margin as opposed to the default dynamic margin. See also
* spacingTop.
*
* @see https://api.highcharts.com/highcharts/chart.marginTop
* @see https://api.highcharts.com/highstock/chart.marginTop
* @see https://api.highcharts.com/highmaps/chart.marginTop
*
* @implspec marginTop?: number;
*
*/
@JSProperty("marginTop")
void setMarginTop(double value);
/**
* (Highcharts) Options to render charts in 3 dimensions. This feature
* requires highcharts-3d.js, found in the download package or online at
* code.highcharts.com/highcharts-3d.js.
*
* @see https://api.highcharts.com/highcharts/chart.options3d
*
* @implspec options3d?: Chart3dOptions;
*
*/
@JSProperty("options3d")
@Nullable
Chart3dOptions getOptions3d();
/**
* (Highcharts) Options to render charts in 3 dimensions. This feature
* requires highcharts-3d.js, found in the download package or online at
* code.highcharts.com/highcharts-3d.js.
*
* @see https://api.highcharts.com/highcharts/chart.options3d
*
* @implspec options3d?: Chart3dOptions;
*
*/
@JSProperty("options3d")
void setOptions3d(Chart3dOptions value);
/**
* (Highcharts, Gantt) Allows setting a key to switch between zooming and
* panning. Can be one of alt, ctrl, meta (the command key on Mac and
* Windows key on Windows) or shift. The keys are mapped directly to the
* key properties of the click event argument (event.altKey,
* event.ctrlKey, event.metaKey and event.shiftKey).
*
* @see https://api.highcharts.com/highcharts/chart.panKey
* @see https://api.highcharts.com/gantt/chart.panKey
*
* @implspec panKey?: ("alt"|"ctrl"|"meta"|"shift");
*
*/
@JSProperty("panKey")
@Nullable
PanKey getPanKey();
/**
* (Highcharts, Gantt) Allows setting a key to switch between zooming and
* panning. Can be one of alt, ctrl, meta (the command key on Mac and
* Windows key on Windows) or shift. The keys are mapped directly to the
* key properties of the click event argument (event.altKey,
* event.ctrlKey, event.metaKey and event.shiftKey).
*
* @see https://api.highcharts.com/highcharts/chart.panKey
* @see https://api.highcharts.com/gantt/chart.panKey
*
* @implspec panKey?: ("alt"|"ctrl"|"meta"|"shift");
*
*/
@JSProperty("panKey")
void setPanKey(PanKey value);
/**
* (Highcharts, Highstock, Gantt) Allow panning in a chart. Best used with
* panKey to combine zooming and panning.
*
* On touch devices, when the tooltip.followTouchMove option is true
* (default), panning requires two fingers. To allow panning with one
* finger, set followTouchMove to false.
*
* @see https://api.highcharts.com/highcharts/chart.panning
* @see https://api.highcharts.com/highstock/chart.panning
* @see https://api.highcharts.com/gantt/chart.panning
*
* @implspec panning?: boolean;
*
*/
@JSProperty("panning")
boolean getPanning();
/**
* (Highcharts, Highstock, Gantt) Allow panning in a chart. Best used with
* panKey to combine zooming and panning.
*
* On touch devices, when the tooltip.followTouchMove option is true
* (default), panning requires two fingers. To allow panning with one
* finger, set followTouchMove to false.
*
* @see https://api.highcharts.com/highcharts/chart.panning
* @see https://api.highcharts.com/highstock/chart.panning
* @see https://api.highcharts.com/gantt/chart.panning
*
* @implspec panning?: boolean;
*
*/
@JSProperty("panning")
void setPanning(boolean value);
/**
* (Highcharts) Common options for all yAxes rendered in a parallel
* coordinates plot. This feature requires
* modules/parallel-coordinates.js.
*
* The default options are: (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.parallelAxes
*
* @implspec parallelAxes?: ChartParallelAxesOptions;
*
*/
@JSProperty("parallelAxes")
@Nullable
ChartParallelAxesOptions getParallelAxes();
/**
* (Highcharts) Common options for all yAxes rendered in a parallel
* coordinates plot. This feature requires
* modules/parallel-coordinates.js.
*
* The default options are: (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.parallelAxes
*
* @implspec parallelAxes?: ChartParallelAxesOptions;
*
*/
@JSProperty("parallelAxes")
void setParallelAxes(ChartParallelAxesOptions value);
/**
* (Highcharts) Flag to render charts as a parallel coordinates plot. In a
* parallel coordinates plot (||-coords) by default all required yAxes are
* generated and the legend is disabled. This feature requires
* modules/parallel-coordinates.js.
*
* @see https://api.highcharts.com/highcharts/chart.parallelCoordinates
*
* @implspec parallelCoordinates?: boolean;
*
*/
@JSProperty("parallelCoordinates")
boolean getParallelCoordinates();
/**
* (Highcharts) Flag to render charts as a parallel coordinates plot. In a
* parallel coordinates plot (||-coords) by default all required yAxes are
* generated and the legend is disabled. This feature requires
* modules/parallel-coordinates.js.
*
* @see https://api.highcharts.com/highcharts/chart.parallelCoordinates
*
* @implspec parallelCoordinates?: boolean;
*
*/
@JSProperty("parallelCoordinates")
void setParallelCoordinates(boolean value);
/**
* (Highcharts, Highstock, Gantt) Equivalent to zoomType, but for multitouch
* gestures only. By default, the pinchType is the same as the zoomType
* setting. However, pinching can be enabled separately in some cases, for
* example in stock charts where a mouse drag pans the chart, while pinching
* is enabled. When tooltip.followTouchMove is true, pinchType only applies
* to two-finger touches.
*
* @see https://api.highcharts.com/highcharts/chart.pinchType
* @see https://api.highcharts.com/highstock/chart.pinchType
* @see https://api.highcharts.com/gantt/chart.pinchType
*
* @implspec pinchType?: ("x"|"xy"|"y");
*
*/
@JSProperty("pinchType")
@Nullable
PinchType getPinchType();
/**
* (Highcharts, Highstock, Gantt) Equivalent to zoomType, but for multitouch
* gestures only. By default, the pinchType is the same as the zoomType
* setting. However, pinching can be enabled separately in some cases, for
* example in stock charts where a mouse drag pans the chart, while pinching
* is enabled. When tooltip.followTouchMove is true, pinchType only applies
* to two-finger touches.
*
* @see https://api.highcharts.com/highcharts/chart.pinchType
* @see https://api.highcharts.com/highstock/chart.pinchType
* @see https://api.highcharts.com/gantt/chart.pinchType
*
* @implspec pinchType?: ("x"|"xy"|"y");
*
*/
@JSProperty("pinchType")
void setPinchType(PinchType value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the plot area.
*
* @see https://api.highcharts.com/highcharts/chart.plotBackgroundColor
* @see https://api.highcharts.com/highstock/chart.plotBackgroundColor
* @see https://api.highcharts.com/highmaps/chart.plotBackgroundColor
*
* @implspec plotBackgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("plotBackgroundColor")
@Nullable
Unknown getPlotBackgroundColor();
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the plot area.
*
* @see https://api.highcharts.com/highcharts/chart.plotBackgroundColor
* @see https://api.highcharts.com/highstock/chart.plotBackgroundColor
* @see https://api.highcharts.com/highmaps/chart.plotBackgroundColor
*
* @implspec plotBackgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("plotBackgroundColor")
void setPlotBackgroundColor(GradientColorObject value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the plot area.
*
* @see https://api.highcharts.com/highcharts/chart.plotBackgroundColor
* @see https://api.highcharts.com/highstock/chart.plotBackgroundColor
* @see https://api.highcharts.com/highmaps/chart.plotBackgroundColor
*
* @implspec plotBackgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("plotBackgroundColor")
void setPlotBackgroundColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the plot area.
*
* @see https://api.highcharts.com/highcharts/chart.plotBackgroundColor
* @see https://api.highcharts.com/highstock/chart.plotBackgroundColor
* @see https://api.highcharts.com/highmaps/chart.plotBackgroundColor
*
* @implspec plotBackgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("plotBackgroundColor")
void setPlotBackgroundColor(Any value);
/**
* (Highcharts, Highstock, Highmaps) The URL for an image to use as the plot
* background. To set an image as the background for the entire chart, set a
* CSS background image to the container element. Note that for the image to
* be applied to exported charts, its URL needs to be accessible by the
* export server.
*
* @see https://api.highcharts.com/highcharts/chart.plotBackgroundImage
* @see https://api.highcharts.com/highstock/chart.plotBackgroundImage
* @see https://api.highcharts.com/highmaps/chart.plotBackgroundImage
*
* @implspec plotBackgroundImage?: string;
*
*/
@JSProperty("plotBackgroundImage")
@Nullable
String getPlotBackgroundImage();
/**
* (Highcharts, Highstock, Highmaps) The URL for an image to use as the plot
* background. To set an image as the background for the entire chart, set a
* CSS background image to the container element. Note that for the image to
* be applied to exported charts, its URL needs to be accessible by the
* export server.
*
* @see https://api.highcharts.com/highcharts/chart.plotBackgroundImage
* @see https://api.highcharts.com/highstock/chart.plotBackgroundImage
* @see https://api.highcharts.com/highmaps/chart.plotBackgroundImage
*
* @implspec plotBackgroundImage?: string;
*
*/
@JSProperty("plotBackgroundImage")
void setPlotBackgroundImage(String value);
/**
* (Highcharts, Highstock, Highmaps) The color of the inner chart or plot
* area border.
*
* @see https://api.highcharts.com/highcharts/chart.plotBorderColor
* @see https://api.highcharts.com/highstock/chart.plotBorderColor
* @see https://api.highcharts.com/highmaps/chart.plotBorderColor
*
* @implspec plotBorderColor?: ColorString;
*
*/
@JSProperty("plotBorderColor")
@Nullable
String getPlotBorderColor();
/**
* (Highcharts, Highstock, Highmaps) The color of the inner chart or plot
* area border.
*
* @see https://api.highcharts.com/highcharts/chart.plotBorderColor
* @see https://api.highcharts.com/highstock/chart.plotBorderColor
* @see https://api.highcharts.com/highmaps/chart.plotBorderColor
*
* @implspec plotBorderColor?: ColorString;
*
*/
@JSProperty("plotBorderColor")
void setPlotBorderColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the plot area
* border.
*
* @see https://api.highcharts.com/highcharts/chart.plotBorderWidth
* @see https://api.highcharts.com/highstock/chart.plotBorderWidth
* @see https://api.highcharts.com/highmaps/chart.plotBorderWidth
*
* @implspec plotBorderWidth?: number;
*
*/
@JSProperty("plotBorderWidth")
double getPlotBorderWidth();
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the plot area
* border.
*
* @see https://api.highcharts.com/highcharts/chart.plotBorderWidth
* @see https://api.highcharts.com/highstock/chart.plotBorderWidth
* @see https://api.highcharts.com/highmaps/chart.plotBorderWidth
*
* @implspec plotBorderWidth?: number;
*
*/
@JSProperty("plotBorderWidth")
void setPlotBorderWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* plot area. Requires that plotBackgroundColor be set. The shadow can be an
* object configuration containing color, offsetX, offsetY, opacity
* and width.
*
* @see https://api.highcharts.com/highcharts/chart.plotShadow
* @see https://api.highcharts.com/highstock/chart.plotShadow
* @see https://api.highcharts.com/highmaps/chart.plotShadow
*
* @implspec plotShadow?: (boolean|CSSObject);
*
*/
@JSProperty("plotShadow")
@Nullable
Unknown getPlotShadow();
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* plot area. Requires that plotBackgroundColor be set. The shadow can be an
* object configuration containing color, offsetX, offsetY, opacity
* and width.
*
* @see https://api.highcharts.com/highcharts/chart.plotShadow
* @see https://api.highcharts.com/highstock/chart.plotShadow
* @see https://api.highcharts.com/highmaps/chart.plotShadow
*
* @implspec plotShadow?: (boolean|CSSObject);
*
*/
@JSProperty("plotShadow")
void setPlotShadow(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* plot area. Requires that plotBackgroundColor be set. The shadow can be an
* object configuration containing color, offsetX, offsetY, opacity
* and width.
*
* @see https://api.highcharts.com/highcharts/chart.plotShadow
* @see https://api.highcharts.com/highstock/chart.plotShadow
* @see https://api.highcharts.com/highmaps/chart.plotShadow
*
* @implspec plotShadow?: (boolean|CSSObject);
*
*/
@JSProperty("plotShadow")
void setPlotShadow(CSSObject value);
/**
* (Highcharts) When true, cartesian charts like line, spline, area and
* column are transformed into the polar coordinate system. This produces
* polar charts, also known as radar charts. Requires
* highcharts-more.js.
*
* @see https://api.highcharts.com/highcharts/chart.polar
*
* @implspec polar?: boolean;
*
*/
@JSProperty("polar")
boolean getPolar();
/**
* (Highcharts) When true, cartesian charts like line, spline, area and
* column are transformed into the polar coordinate system. This produces
* polar charts, also known as radar charts. Requires
* highcharts-more.js.
*
* @see https://api.highcharts.com/highcharts/chart.polar
*
* @implspec polar?: boolean;
*
*/
@JSProperty("polar")
void setPolar(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to reflow the chart to fit the
* width of the container div on resizing the window.
*
* @see https://api.highcharts.com/highcharts/chart.reflow
* @see https://api.highcharts.com/highstock/chart.reflow
* @see https://api.highcharts.com/highmaps/chart.reflow
*
* @implspec reflow?: boolean;
*
*/
@JSProperty("reflow")
boolean getReflow();
/**
* (Highcharts, Highstock, Highmaps) Whether to reflow the chart to fit the
* width of the container div on resizing the window.
*
* @see https://api.highcharts.com/highcharts/chart.reflow
* @see https://api.highcharts.com/highstock/chart.reflow
* @see https://api.highcharts.com/highmaps/chart.reflow
*
* @implspec reflow?: boolean;
*
*/
@JSProperty("reflow")
void setReflow(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The HTML element where the chart will
* be rendered. If it is a string, the element by that id is used. The HTML
* element can also be passed by direct reference, or as the first argument
* of the chart constructor, in which case the option is not needed.
*
* @see https://api.highcharts.com/highcharts/chart.renderTo
* @see https://api.highcharts.com/highstock/chart.renderTo
* @see https://api.highcharts.com/highmaps/chart.renderTo
*
* @implspec renderTo?: (string|SVGDOMElement);
*
*/
@JSProperty("renderTo")
@Nullable
Unknown getRenderTo();
/**
* (Highcharts, Highstock, Highmaps) The HTML element where the chart will
* be rendered. If it is a string, the element by that id is used. The HTML
* element can also be passed by direct reference, or as the first argument
* of the chart constructor, in which case the option is not needed.
*
* @see https://api.highcharts.com/highcharts/chart.renderTo
* @see https://api.highcharts.com/highstock/chart.renderTo
* @see https://api.highcharts.com/highmaps/chart.renderTo
*
* @implspec renderTo?: (string|SVGDOMElement);
*
*/
@JSProperty("renderTo")
void setRenderTo(js.web.dom.svg.SVGElement value);
/**
* (Highcharts, Highstock, Highmaps) The HTML element where the chart will
* be rendered. If it is a string, the element by that id is used. The HTML
* element can also be passed by direct reference, or as the first argument
* of the chart constructor, in which case the option is not needed.
*
* @see https://api.highcharts.com/highcharts/chart.renderTo
* @see https://api.highcharts.com/highstock/chart.renderTo
* @see https://api.highcharts.com/highmaps/chart.renderTo
*
* @implspec renderTo?: (string|SVGDOMElement);
*
*/
@JSProperty("renderTo")
void setRenderTo(String value);
/**
* (Highcharts, Highstock, Highmaps) The button that appears after a
* selection zoom, allowing the user to reset zoom.
*
* @see https://api.highcharts.com/highcharts/chart.resetZoomButton
* @see https://api.highcharts.com/highstock/chart.resetZoomButton
* @see https://api.highcharts.com/highmaps/chart.resetZoomButton
*
* @implspec resetZoomButton?: ChartResetZoomButtonOptions;
*
*/
@JSProperty("resetZoomButton")
@Nullable
ChartResetZoomButtonOptions getResetZoomButton();
/**
* (Highcharts, Highstock, Highmaps) The button that appears after a
* selection zoom, allowing the user to reset zoom.
*
* @see https://api.highcharts.com/highcharts/chart.resetZoomButton
* @see https://api.highcharts.com/highstock/chart.resetZoomButton
* @see https://api.highcharts.com/highmaps/chart.resetZoomButton
*
* @implspec resetZoomButton?: ChartResetZoomButtonOptions;
*
*/
@JSProperty("resetZoomButton")
void setResetZoomButton(ChartResetZoomButtonOptions value);
/**
* (Highcharts, Gantt) Options for a scrollable plot area. This feature
* provides a minimum width for the plot area of the chart. If the width
* gets smaller than this, typically on mobile devices, a native browser
* scrollbar is presented below the chart. This scrollbar provides smooth
* scrolling for the contents of the plot area, whereas the title, legend
* and axes are fixed.
*
* @see https://api.highcharts.com/highcharts/chart.scrollablePlotArea
* @see https://api.highcharts.com/gantt/chart.scrollablePlotArea
*
* @implspec scrollablePlotArea?: ChartScrollablePlotAreaOptions;
*
*/
@JSProperty("scrollablePlotArea")
@Nullable
ChartScrollablePlotAreaOptions getScrollablePlotArea();
/**
* (Highcharts, Gantt) Options for a scrollable plot area. This feature
* provides a minimum width for the plot area of the chart. If the width
* gets smaller than this, typically on mobile devices, a native browser
* scrollbar is presented below the chart. This scrollbar provides smooth
* scrolling for the contents of the plot area, whereas the title, legend
* and axes are fixed.
*
* @see https://api.highcharts.com/highcharts/chart.scrollablePlotArea
* @see https://api.highcharts.com/gantt/chart.scrollablePlotArea
*
* @implspec scrollablePlotArea?: ChartScrollablePlotAreaOptions;
*
*/
@JSProperty("scrollablePlotArea")
void setScrollablePlotArea(ChartScrollablePlotAreaOptions value);
/**
* (Highcharts, Highstock, Highmaps) The background color of the marker
* square when selecting (zooming in on) an area of the chart.
*
* @see https://api.highcharts.com/highcharts/chart.selectionMarkerFill
* @see https://api.highcharts.com/highstock/chart.selectionMarkerFill
* @see https://api.highcharts.com/highmaps/chart.selectionMarkerFill
*
* @implspec selectionMarkerFill?: ColorString;
*
*/
@JSProperty("selectionMarkerFill")
@Nullable
String getSelectionMarkerFill();
/**
* (Highcharts, Highstock, Highmaps) The background color of the marker
* square when selecting (zooming in on) an area of the chart.
*
* @see https://api.highcharts.com/highcharts/chart.selectionMarkerFill
* @see https://api.highcharts.com/highstock/chart.selectionMarkerFill
* @see https://api.highcharts.com/highmaps/chart.selectionMarkerFill
*
* @implspec selectionMarkerFill?: ColorString;
*
*/
@JSProperty("selectionMarkerFill")
void setSelectionMarkerFill(String value);
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* outer chart area. Requires that backgroundColor be set. The shadow can be
* an object configuration containing color, offsetX, offsetY,
* opacity and width.
*
* @see https://api.highcharts.com/highcharts/chart.shadow
* @see https://api.highcharts.com/highstock/chart.shadow
* @see https://api.highcharts.com/highmaps/chart.shadow
*
* @implspec shadow?: (boolean|CSSObject);
*
*/
@JSProperty("shadow")
@Nullable
Unknown getShadow();
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* outer chart area. Requires that backgroundColor be set. The shadow can be
* an object configuration containing color, offsetX, offsetY,
* opacity and width.
*
* @see https://api.highcharts.com/highcharts/chart.shadow
* @see https://api.highcharts.com/highstock/chart.shadow
* @see https://api.highcharts.com/highmaps/chart.shadow
*
* @implspec shadow?: (boolean|CSSObject);
*
*/
@JSProperty("shadow")
void setShadow(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* outer chart area. Requires that backgroundColor be set. The shadow can be
* an object configuration containing color, offsetX, offsetY,
* opacity and width.
*
* @see https://api.highcharts.com/highcharts/chart.shadow
* @see https://api.highcharts.com/highstock/chart.shadow
* @see https://api.highcharts.com/highmaps/chart.shadow
*
* @implspec shadow?: (boolean|CSSObject);
*
*/
@JSProperty("shadow")
void setShadow(CSSObject value);
/**
* (Highcharts, Gantt) Whether to show the axes initially. This only applies
* to empty charts where series are added dynamically, as axes are
* automatically added to cartesian series.
*
* @see https://api.highcharts.com/highcharts/chart.showAxes
* @see https://api.highcharts.com/gantt/chart.showAxes
*
* @implspec showAxes?: boolean;
*
*/
@JSProperty("showAxes")
boolean getShowAxes();
/**
* (Highcharts, Gantt) Whether to show the axes initially. This only applies
* to empty charts where series are added dynamically, as axes are
* automatically added to cartesian series.
*
* @see https://api.highcharts.com/highcharts/chart.showAxes
* @see https://api.highcharts.com/gantt/chart.showAxes
*
* @implspec showAxes?: boolean;
*
*/
@JSProperty("showAxes")
void setShowAxes(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The distance between the outer edge of
* the chart and the content, like title or legend, or axis title and labels
* if present. The numbers in the array designate top, right, bottom and
* left respectively. Use the options spacingTop, spacingRight,
* spacingBottom and spacingLeft options for shorthand setting of one
* option.
*
* @see https://api.highcharts.com/highcharts/chart.spacing
* @see https://api.highcharts.com/highstock/chart.spacing
* @see https://api.highcharts.com/highmaps/chart.spacing
*
* @implspec spacing?: Array;
*
*/
@JSProperty("spacing")
@Nullable
double[] getSpacing();
/**
* (Highcharts, Highstock, Highmaps) The distance between the outer edge of
* the chart and the content, like title or legend, or axis title and labels
* if present. The numbers in the array designate top, right, bottom and
* left respectively. Use the options spacingTop, spacingRight,
* spacingBottom and spacingLeft options for shorthand setting of one
* option.
*
* @see https://api.highcharts.com/highcharts/chart.spacing
* @see https://api.highcharts.com/highstock/chart.spacing
* @see https://api.highcharts.com/highmaps/chart.spacing
*
* @implspec spacing?: Array;
*
*/
@JSProperty("spacing")
void setSpacing(double[] value);
/**
* (Highcharts, Highstock, Highmaps) The space between the bottom edge of
* the chart and the content (plot area, axis title and labels, title,
* subtitle or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingBottom
* @see https://api.highcharts.com/highstock/chart.spacingBottom
* @see https://api.highcharts.com/highmaps/chart.spacingBottom
*
* @implspec spacingBottom?: number;
*
*/
@JSProperty("spacingBottom")
double getSpacingBottom();
/**
* (Highcharts, Highstock, Highmaps) The space between the bottom edge of
* the chart and the content (plot area, axis title and labels, title,
* subtitle or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingBottom
* @see https://api.highcharts.com/highstock/chart.spacingBottom
* @see https://api.highcharts.com/highmaps/chart.spacingBottom
*
* @implspec spacingBottom?: number;
*
*/
@JSProperty("spacingBottom")
void setSpacingBottom(double value);
/**
* (Highcharts, Highstock, Highmaps) The space between the left edge of the
* chart and the content (plot area, axis title and labels, title, subtitle
* or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingLeft
* @see https://api.highcharts.com/highstock/chart.spacingLeft
* @see https://api.highcharts.com/highmaps/chart.spacingLeft
*
* @implspec spacingLeft?: number;
*
*/
@JSProperty("spacingLeft")
double getSpacingLeft();
/**
* (Highcharts, Highstock, Highmaps) The space between the left edge of the
* chart and the content (plot area, axis title and labels, title, subtitle
* or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingLeft
* @see https://api.highcharts.com/highstock/chart.spacingLeft
* @see https://api.highcharts.com/highmaps/chart.spacingLeft
*
* @implspec spacingLeft?: number;
*
*/
@JSProperty("spacingLeft")
void setSpacingLeft(double value);
/**
* (Highcharts, Highstock, Highmaps) The space between the right edge of the
* chart and the content (plot area, axis title and labels, title, subtitle
* or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingRight
* @see https://api.highcharts.com/highstock/chart.spacingRight
* @see https://api.highcharts.com/highmaps/chart.spacingRight
*
* @implspec spacingRight?: number;
*
*/
@JSProperty("spacingRight")
double getSpacingRight();
/**
* (Highcharts, Highstock, Highmaps) The space between the right edge of the
* chart and the content (plot area, axis title and labels, title, subtitle
* or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingRight
* @see https://api.highcharts.com/highstock/chart.spacingRight
* @see https://api.highcharts.com/highmaps/chart.spacingRight
*
* @implspec spacingRight?: number;
*
*/
@JSProperty("spacingRight")
void setSpacingRight(double value);
/**
* (Highcharts, Highstock, Highmaps) The space between the top edge of the
* chart and the content (plot area, axis title and labels, title, subtitle
* or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingTop
* @see https://api.highcharts.com/highstock/chart.spacingTop
* @see https://api.highcharts.com/highmaps/chart.spacingTop
*
* @implspec spacingTop?: number;
*
*/
@JSProperty("spacingTop")
double getSpacingTop();
/**
* (Highcharts, Highstock, Highmaps) The space between the top edge of the
* chart and the content (plot area, axis title and labels, title, subtitle
* or legend in top position).
*
* @see https://api.highcharts.com/highcharts/chart.spacingTop
* @see https://api.highcharts.com/highstock/chart.spacingTop
* @see https://api.highcharts.com/highmaps/chart.spacingTop
*
* @implspec spacingTop?: number;
*
*/
@JSProperty("spacingTop")
void setSpacingTop(double value);
/**
* (Highcharts, Highstock, Highmaps) Additional CSS styles to apply inline
* to the container div. Note that since the default font styles are
* applied in the renderer, it is ignorant of the individual chart options
* and must be set globally.
*
* @see https://api.highcharts.com/highcharts/chart.style
* @see https://api.highcharts.com/highstock/chart.style
* @see https://api.highcharts.com/highmaps/chart.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highcharts, Highstock, Highmaps) Additional CSS styles to apply inline
* to the container div. Note that since the default font styles are
* applied in the renderer, it is ignorant of the individual chart options
* and must be set globally.
*
* @see https://api.highcharts.com/highcharts/chart.style
* @see https://api.highcharts.com/highstock/chart.style
* @see https://api.highcharts.com/highmaps/chart.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) The default series type for the chart.
* Can be any of the chart types listed under plotOptions.
*
* This property has no effect in TypeScript. Instead you always have to set
* the type option in plotOptions and series.
*
* @see https://api.highcharts.com/highcharts/chart.type
* @see https://api.highcharts.com/highstock/chart.type
* @see https://api.highcharts.com/highmaps/chart.type
*
* @implspec type?: string;
*
*/
@JSProperty("type")
@Nullable
String getType();
/**
* (Highcharts, Highstock, Highmaps) The default series type for the chart.
* Can be any of the chart types listed under plotOptions.
*
* This property has no effect in TypeScript. Instead you always have to set
* the type option in plotOptions and series.
*
* @see https://api.highcharts.com/highcharts/chart.type
* @see https://api.highcharts.com/highstock/chart.type
* @see https://api.highcharts.com/highmaps/chart.type
*
* @implspec type?: string;
*
*/
@JSProperty("type")
void setType(String value);
/**
* (Highcharts, Highstock, Highmaps) A text description of the chart type.
*
* If the Accessibility module is loaded, this will be included in the
* description of the chart in the screen reader information region.
*
* Highcharts will by default attempt to guess the chart type, but for more
* complex charts it is recommended to specify this property for clarity.
*
* @see https://api.highcharts.com/highcharts/chart.typeDescription
* @see https://api.highcharts.com/highstock/chart.typeDescription
* @see https://api.highcharts.com/highmaps/chart.typeDescription
*
* @implspec typeDescription?: string;
*
*/
@JSProperty("typeDescription")
@Nullable
String getTypeDescription();
/**
* (Highcharts, Highstock, Highmaps) A text description of the chart type.
*
* If the Accessibility module is loaded, this will be included in the
* description of the chart in the screen reader information region.
*
* Highcharts will by default attempt to guess the chart type, but for more
* complex charts it is recommended to specify this property for clarity.
*
* @see https://api.highcharts.com/highcharts/chart.typeDescription
* @see https://api.highcharts.com/highstock/chart.typeDescription
* @see https://api.highcharts.com/highmaps/chart.typeDescription
*
* @implspec typeDescription?: string;
*
*/
@JSProperty("typeDescription")
void setTypeDescription(String value);
/**
* (Highcharts, Highstock, Highmaps) An explicit width for the chart. By
* default (when null) the width is calculated from the offset width of
* the containing element.
*
* @see https://api.highcharts.com/highcharts/chart.width
* @see https://api.highcharts.com/highstock/chart.width
* @see https://api.highcharts.com/highmaps/chart.width
*
* @implspec width?: (number|null);
*
*/
@JSProperty("width")
double getWidth();
/**
* (Highcharts, Highstock, Highmaps) An explicit width for the chart. By
* default (when null) the width is calculated from the offset width of
* the containing element.
*
* @see https://api.highcharts.com/highcharts/chart.width
* @see https://api.highcharts.com/highstock/chart.width
* @see https://api.highcharts.com/highmaps/chart.width
*
* @implspec width?: (number|null);
*
*/
@JSProperty("width")
void setWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) Set a key to hold when dragging to zoom
* the chart. Requires the draggable-points module. This is useful to avoid
* zooming while moving points. Should be set different than chart.panKey.
*
* @see https://api.highcharts.com/highcharts/chart.zoomKey
* @see https://api.highcharts.com/highstock/chart.zoomKey
* @see https://api.highcharts.com/highmaps/chart.zoomKey
*
* @implspec zoomKey?: ("alt"|"ctrl"|"meta"|"shift");
*
*/
@JSProperty("zoomKey")
@Nullable
ZoomKey getZoomKey();
/**
* (Highcharts, Highstock, Highmaps) Set a key to hold when dragging to zoom
* the chart. Requires the draggable-points module. This is useful to avoid
* zooming while moving points. Should be set different than chart.panKey.
*
* @see https://api.highcharts.com/highcharts/chart.zoomKey
* @see https://api.highcharts.com/highstock/chart.zoomKey
* @see https://api.highcharts.com/highmaps/chart.zoomKey
*
* @implspec zoomKey?: ("alt"|"ctrl"|"meta"|"shift");
*
*/
@JSProperty("zoomKey")
void setZoomKey(ZoomKey value);
/**
* (Highcharts, Highstock, Gantt) Decides in what dimensions the user can
* zoom by dragging the mouse. Can be one of x, y or xy.
*
* @see https://api.highcharts.com/highcharts/chart.zoomType
* @see https://api.highcharts.com/highstock/chart.zoomType
* @see https://api.highcharts.com/gantt/chart.zoomType
*
* @implspec zoomType?: ("x"|"xy"|"y");
*
*/
@JSProperty("zoomType")
@Nullable
ZoomType getZoomType();
/**
* (Highcharts, Highstock, Gantt) Decides in what dimensions the user can
* zoom by dragging the mouse. Can be one of x, y or xy.
*
* @see https://api.highcharts.com/highcharts/chart.zoomType
* @see https://api.highcharts.com/highstock/chart.zoomType
* @see https://api.highcharts.com/gantt/chart.zoomType
*
* @implspec zoomType?: ("x"|"xy"|"y");
*
*/
@JSProperty("zoomType")
void setZoomType(ZoomType value);
/**
*/
abstract class PanKey extends JsEnum {
public static final PanKey ALT = JsEnum.of("alt");
public static final PanKey CTRL = JsEnum.of("ctrl");
public static final PanKey META = JsEnum.of("meta");
public static final PanKey SHIFT = JsEnum.of("shift");
}
/**
*/
abstract class PinchType extends JsEnum {
public static final PinchType X = JsEnum.of("x");
public static final PinchType XY = JsEnum.of("xy");
public static final PinchType Y = JsEnum.of("y");
}
/**
*/
abstract class ZoomKey extends JsEnum {
public static final ZoomKey ALT = JsEnum.of("alt");
public static final ZoomKey CTRL = JsEnum.of("ctrl");
public static final ZoomKey META = JsEnum.of("meta");
public static final ZoomKey SHIFT = JsEnum.of("shift");
}
/**
*/
abstract class ZoomType extends JsEnum {
public static final ZoomType X = JsEnum.of("x");
public static final ZoomType XY = JsEnum.of("xy");
public static final ZoomType Y = JsEnum.of("y");
}
}