com.github.fluorumlabs.disconnect.highcharts.LegendOptions 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 java.lang.String;
import javax.annotation.Nullable;
import js.extras.JsEnum;
import js.lang.Any;
import js.lang.Unknown;
import org.teavm.jso.JSProperty;
/**
* (Highcharts, Highstock, Highmaps) The legend is a box containing a symbol and
* name for each series item or point item in the chart. Each series (or points
* in case of pie charts) is represented by a symbol and its name in the legend.
*
* It is possible to override the symbol creator function and create custom
* legend symbols.
*
* @see https://api.highcharts.com/highcharts/legend
* @see https://api.highcharts.com/highstock/legend
* @see https://api.highcharts.com/highmaps/legend
*
*/
public interface LegendOptions extends Any {
/**
* (Highcharts, Highstock, Highmaps) The horizontal alignment of the legend
* box within the chart area. Valid values are left, center and right.
*
* In the case that the legend is aligned in a corner position, the layout
* option will determine whether to place it above/below or on the side of
* the plot area.
*
* @see https://api.highcharts.com/highcharts/legend.align
* @see https://api.highcharts.com/highstock/legend.align
* @see https://api.highcharts.com/highmaps/legend.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
@Nullable
Align getAlign();
/**
* (Highcharts, Highstock, Highmaps) The horizontal alignment of the legend
* box within the chart area. Valid values are left, center and right.
*
* In the case that the legend is aligned in a corner position, the layout
* option will determine whether to place it above/below or on the side of
* the plot area.
*
* @see https://api.highcharts.com/highcharts/legend.align
* @see https://api.highcharts.com/highstock/legend.align
* @see https://api.highcharts.com/highmaps/legend.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
void setAlign(Align value);
/**
* (Highcharts, Highstock, Highmaps) If the layout is horizontal and the
* legend items span over two lines or more, whether to align the items into
* vertical columns. Setting this to false makes room for more items, but
* will look more messy.
*
* @see https://api.highcharts.com/highcharts/legend.alignColumns
* @see https://api.highcharts.com/highstock/legend.alignColumns
* @see https://api.highcharts.com/highmaps/legend.alignColumns
*
* @implspec alignColumns?: boolean;
*
*/
@JSProperty("alignColumns")
boolean getAlignColumns();
/**
* (Highcharts, Highstock, Highmaps) If the layout is horizontal and the
* legend items span over two lines or more, whether to align the items into
* vertical columns. Setting this to false makes room for more items, but
* will look more messy.
*
* @see https://api.highcharts.com/highcharts/legend.alignColumns
* @see https://api.highcharts.com/highstock/legend.alignColumns
* @see https://api.highcharts.com/highmaps/legend.alignColumns
*
* @implspec alignColumns?: boolean;
*
*/
@JSProperty("alignColumns")
void setAlignColumns(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The background color of the legend.
*
* @see https://api.highcharts.com/highcharts/legend.backgroundColor
* @see https://api.highcharts.com/highstock/legend.backgroundColor
* @see https://api.highcharts.com/highmaps/legend.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
@Nullable
Unknown getBackgroundColor();
/**
* (Highcharts, Highstock, Highmaps) The background color of the legend.
*
* @see https://api.highcharts.com/highcharts/legend.backgroundColor
* @see https://api.highcharts.com/highstock/legend.backgroundColor
* @see https://api.highcharts.com/highmaps/legend.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(GradientColorObject value);
/**
* (Highcharts, Highstock, Highmaps) The background color of the legend.
*
* @see https://api.highcharts.com/highcharts/legend.backgroundColor
* @see https://api.highcharts.com/highstock/legend.backgroundColor
* @see https://api.highcharts.com/highmaps/legend.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The background color of the legend.
*
* @see https://api.highcharts.com/highcharts/legend.backgroundColor
* @see https://api.highcharts.com/highstock/legend.backgroundColor
* @see https://api.highcharts.com/highmaps/legend.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(Any value);
/**
* (Highcharts, Highstock, Highmaps) The color of the drawn border around
* the legend.
*
* @see https://api.highcharts.com/highcharts/legend.borderColor
* @see https://api.highcharts.com/highstock/legend.borderColor
* @see https://api.highcharts.com/highmaps/legend.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
@Nullable
String getBorderColor();
/**
* (Highcharts, Highstock, Highmaps) The color of the drawn border around
* the legend.
*
* @see https://api.highcharts.com/highcharts/legend.borderColor
* @see https://api.highcharts.com/highstock/legend.borderColor
* @see https://api.highcharts.com/highmaps/legend.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
void setBorderColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The border corner radius of the legend.
*
* @see https://api.highcharts.com/highcharts/legend.borderRadius
* @see https://api.highcharts.com/highstock/legend.borderRadius
* @see https://api.highcharts.com/highmaps/legend.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
double getBorderRadius();
/**
* (Highcharts, Highstock, Highmaps) The border corner radius of the legend.
*
* @see https://api.highcharts.com/highcharts/legend.borderRadius
* @see https://api.highcharts.com/highstock/legend.borderRadius
* @see https://api.highcharts.com/highmaps/legend.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
void setBorderRadius(double value);
/**
* (Highcharts, Highstock, Highmaps) The width of the drawn border around
* the legend.
*
* @see https://api.highcharts.com/highcharts/legend.borderWidth
* @see https://api.highcharts.com/highstock/legend.borderWidth
* @see https://api.highcharts.com/highmaps/legend.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
double getBorderWidth();
/**
* (Highcharts, Highstock, Highmaps) The width of the drawn border around
* the legend.
*
* @see https://api.highcharts.com/highcharts/legend.borderWidth
* @see https://api.highcharts.com/highstock/legend.borderWidth
* @see https://api.highcharts.com/highmaps/legend.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
void setBorderWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) Enable or disable the legend. There is
* also a series-specific option, showInLegend, that can hide the series
* from the legend. In some series types this is false by default, so it
* must set to true in order to show the legend for the series.
*
* @see https://api.highcharts.com/highcharts/legend.enabled
* @see https://api.highcharts.com/highstock/legend.enabled
* @see https://api.highcharts.com/highmaps/legend.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
boolean getEnabled();
/**
* (Highcharts, Highstock, Highmaps) Enable or disable the legend. There is
* also a series-specific option, showInLegend, that can hide the series
* from the legend. In some series types this is false by default, so it
* must set to true in order to show the legend for the series.
*
* @see https://api.highcharts.com/highcharts/legend.enabled
* @see https://api.highcharts.com/highstock/legend.enabled
* @see https://api.highcharts.com/highmaps/legend.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
void setEnabled(boolean value);
/**
* (Highcharts, Highstock, Highmaps) When the legend is floating, the plot
* area ignores it and is allowed to be placed below it.
*
* @see https://api.highcharts.com/highcharts/legend.floating
* @see https://api.highcharts.com/highstock/legend.floating
* @see https://api.highcharts.com/highmaps/legend.floating
*
* @implspec floating?: boolean;
*
*/
@JSProperty("floating")
boolean getFloating();
/**
* (Highcharts, Highstock, Highmaps) When the legend is floating, the plot
* area ignores it and is allowed to be placed below it.
*
* @see https://api.highcharts.com/highcharts/legend.floating
* @see https://api.highcharts.com/highstock/legend.floating
* @see https://api.highcharts.com/highmaps/legend.floating
*
* @implspec floating?: boolean;
*
*/
@JSProperty("floating")
void setFloating(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Default styling for the checkbox next
* to a legend item when showCheckbox is true.
*
* @see https://api.highcharts.com/highcharts/legend.itemCheckboxStyle
* @see https://api.highcharts.com/highstock/legend.itemCheckboxStyle
* @see https://api.highcharts.com/highmaps/legend.itemCheckboxStyle
*
* @implspec itemCheckboxStyle?: (CSSObject|LegendItemCheckboxStyleOptions);
*
*/
@JSProperty("itemCheckboxStyle")
@Nullable
Unknown getItemCheckboxStyle();
/**
* (Highcharts, Highstock, Highmaps) Default styling for the checkbox next
* to a legend item when showCheckbox is true.
*
* @see https://api.highcharts.com/highcharts/legend.itemCheckboxStyle
* @see https://api.highcharts.com/highstock/legend.itemCheckboxStyle
* @see https://api.highcharts.com/highmaps/legend.itemCheckboxStyle
*
* @implspec itemCheckboxStyle?: (CSSObject|LegendItemCheckboxStyleOptions);
*
*/
@JSProperty("itemCheckboxStyle")
void setItemCheckboxStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) Default styling for the checkbox next
* to a legend item when showCheckbox is true.
*
* @see https://api.highcharts.com/highcharts/legend.itemCheckboxStyle
* @see https://api.highcharts.com/highstock/legend.itemCheckboxStyle
* @see https://api.highcharts.com/highmaps/legend.itemCheckboxStyle
*
* @implspec itemCheckboxStyle?: (CSSObject|LegendItemCheckboxStyleOptions);
*
*/
@JSProperty("itemCheckboxStyle")
void setItemCheckboxStyle(LegendItemCheckboxStyleOptions value);
/**
* (Highcharts, Highstock, Highmaps) In a legend with horizontal layout, the
* itemDistance defines the pixel distance between each item.
*
* @see https://api.highcharts.com/highcharts/legend.itemDistance
* @see https://api.highcharts.com/highstock/legend.itemDistance
* @see https://api.highcharts.com/highmaps/legend.itemDistance
*
* @implspec itemDistance?: number;
*
*/
@JSProperty("itemDistance")
double getItemDistance();
/**
* (Highcharts, Highstock, Highmaps) In a legend with horizontal layout, the
* itemDistance defines the pixel distance between each item.
*
* @see https://api.highcharts.com/highcharts/legend.itemDistance
* @see https://api.highcharts.com/highstock/legend.itemDistance
* @see https://api.highcharts.com/highmaps/legend.itemDistance
*
* @implspec itemDistance?: number;
*
*/
@JSProperty("itemDistance")
void setItemDistance(double value);
/**
* (Highcharts, Highstock, Highmaps) CSS styles for each legend item when
* the corresponding series or point is hidden. Only a subset of CSS is
* supported, notably those options related to text. Properties are
* inherited from style unless overridden here.
*
* @see https://api.highcharts.com/highcharts/legend.itemHiddenStyle
* @see https://api.highcharts.com/highstock/legend.itemHiddenStyle
* @see https://api.highcharts.com/highmaps/legend.itemHiddenStyle
*
* @implspec itemHiddenStyle?: CSSObject;
*
*/
@JSProperty("itemHiddenStyle")
@Nullable
CSSObject getItemHiddenStyle();
/**
* (Highcharts, Highstock, Highmaps) CSS styles for each legend item when
* the corresponding series or point is hidden. Only a subset of CSS is
* supported, notably those options related to text. Properties are
* inherited from style unless overridden here.
*
* @see https://api.highcharts.com/highcharts/legend.itemHiddenStyle
* @see https://api.highcharts.com/highstock/legend.itemHiddenStyle
* @see https://api.highcharts.com/highmaps/legend.itemHiddenStyle
*
* @implspec itemHiddenStyle?: CSSObject;
*
*/
@JSProperty("itemHiddenStyle")
void setItemHiddenStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) CSS styles for each legend item in
* hover mode. Only a subset of CSS is supported, notably those options
* related to text. Properties are inherited from style unless overridden
* here.
*
* @see https://api.highcharts.com/highcharts/legend.itemHoverStyle
* @see https://api.highcharts.com/highstock/legend.itemHoverStyle
* @see https://api.highcharts.com/highmaps/legend.itemHoverStyle
*
* @implspec itemHoverStyle?: CSSObject;
*
*/
@JSProperty("itemHoverStyle")
@Nullable
CSSObject getItemHoverStyle();
/**
* (Highcharts, Highstock, Highmaps) CSS styles for each legend item in
* hover mode. Only a subset of CSS is supported, notably those options
* related to text. Properties are inherited from style unless overridden
* here.
*
* @see https://api.highcharts.com/highcharts/legend.itemHoverStyle
* @see https://api.highcharts.com/highstock/legend.itemHoverStyle
* @see https://api.highcharts.com/highmaps/legend.itemHoverStyle
*
* @implspec itemHoverStyle?: CSSObject;
*
*/
@JSProperty("itemHoverStyle")
void setItemHoverStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) The pixel bottom margin for each legend
* item.
*
* @see https://api.highcharts.com/highcharts/legend.itemMarginBottom
* @see https://api.highcharts.com/highstock/legend.itemMarginBottom
* @see https://api.highcharts.com/highmaps/legend.itemMarginBottom
*
* @implspec itemMarginBottom?: number;
*
*/
@JSProperty("itemMarginBottom")
double getItemMarginBottom();
/**
* (Highcharts, Highstock, Highmaps) The pixel bottom margin for each legend
* item.
*
* @see https://api.highcharts.com/highcharts/legend.itemMarginBottom
* @see https://api.highcharts.com/highstock/legend.itemMarginBottom
* @see https://api.highcharts.com/highmaps/legend.itemMarginBottom
*
* @implspec itemMarginBottom?: number;
*
*/
@JSProperty("itemMarginBottom")
void setItemMarginBottom(double value);
/**
* (Highcharts, Highstock, Highmaps) The pixel top margin for each legend
* item.
*
* @see https://api.highcharts.com/highcharts/legend.itemMarginTop
* @see https://api.highcharts.com/highstock/legend.itemMarginTop
* @see https://api.highcharts.com/highmaps/legend.itemMarginTop
*
* @implspec itemMarginTop?: number;
*
*/
@JSProperty("itemMarginTop")
double getItemMarginTop();
/**
* (Highcharts, Highstock, Highmaps) The pixel top margin for each legend
* item.
*
* @see https://api.highcharts.com/highcharts/legend.itemMarginTop
* @see https://api.highcharts.com/highstock/legend.itemMarginTop
* @see https://api.highcharts.com/highmaps/legend.itemMarginTop
*
* @implspec itemMarginTop?: number;
*
*/
@JSProperty("itemMarginTop")
void setItemMarginTop(double value);
/**
* (Highcharts, Highstock, Highmaps) CSS styles for each legend item. Only a
* subset of CSS is supported, notably those options related to text. The
* default textOverflow property makes long texts truncate. Set it to
* undefined to wrap text instead. A width property can be added to
* control the text width.
*
* @see https://api.highcharts.com/highcharts/legend.itemStyle
* @see https://api.highcharts.com/highstock/legend.itemStyle
* @see https://api.highcharts.com/highmaps/legend.itemStyle
*
* @implspec itemStyle?: (CSSObject|LegendItemStyleOptions);
*
*/
@JSProperty("itemStyle")
@Nullable
Unknown getItemStyle();
/**
* (Highcharts, Highstock, Highmaps) CSS styles for each legend item. Only a
* subset of CSS is supported, notably those options related to text. The
* default textOverflow property makes long texts truncate. Set it to
* undefined to wrap text instead. A width property can be added to
* control the text width.
*
* @see https://api.highcharts.com/highcharts/legend.itemStyle
* @see https://api.highcharts.com/highstock/legend.itemStyle
* @see https://api.highcharts.com/highmaps/legend.itemStyle
*
* @implspec itemStyle?: (CSSObject|LegendItemStyleOptions);
*
*/
@JSProperty("itemStyle")
void setItemStyle(LegendItemStyleOptions value);
/**
* (Highcharts, Highstock, Highmaps) CSS styles for each legend item. Only a
* subset of CSS is supported, notably those options related to text. The
* default textOverflow property makes long texts truncate. Set it to
* undefined to wrap text instead. A width property can be added to
* control the text width.
*
* @see https://api.highcharts.com/highcharts/legend.itemStyle
* @see https://api.highcharts.com/highstock/legend.itemStyle
* @see https://api.highcharts.com/highmaps/legend.itemStyle
*
* @implspec itemStyle?: (CSSObject|LegendItemStyleOptions);
*
*/
@JSProperty("itemStyle")
void setItemStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) The width for each legend item. By
* default the items are laid out successively. In a horizontal layout, if
* the items are laid out across two rows or more, they will be vertically
* aligned depending on the legend.alignColumns option.
*
* @see https://api.highcharts.com/highcharts/legend.itemWidth
* @see https://api.highcharts.com/highstock/legend.itemWidth
* @see https://api.highcharts.com/highmaps/legend.itemWidth
*
* @implspec itemWidth?: number;
*
*/
@JSProperty("itemWidth")
double getItemWidth();
/**
* (Highcharts, Highstock, Highmaps) The width for each legend item. By
* default the items are laid out successively. In a horizontal layout, if
* the items are laid out across two rows or more, they will be vertically
* aligned depending on the legend.alignColumns option.
*
* @see https://api.highcharts.com/highcharts/legend.itemWidth
* @see https://api.highcharts.com/highstock/legend.itemWidth
* @see https://api.highcharts.com/highmaps/legend.itemWidth
*
* @implspec itemWidth?: number;
*
*/
@JSProperty("itemWidth")
void setItemWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) Keyboard navigation for the legend.
* Requires the Accessibility module.
*
* @see https://api.highcharts.com/highcharts/legend.keyboardNavigation
* @see https://api.highcharts.com/highstock/legend.keyboardNavigation
* @see https://api.highcharts.com/highmaps/legend.keyboardNavigation
*
* @implspec keyboardNavigation?: LegendKeyboardNavigationOptions;
*
*/
@JSProperty("keyboardNavigation")
@Nullable
LegendKeyboardNavigationOptions getKeyboardNavigation();
/**
* (Highcharts, Highstock, Highmaps) Keyboard navigation for the legend.
* Requires the Accessibility module.
*
* @see https://api.highcharts.com/highcharts/legend.keyboardNavigation
* @see https://api.highcharts.com/highstock/legend.keyboardNavigation
* @see https://api.highcharts.com/highmaps/legend.keyboardNavigation
*
* @implspec keyboardNavigation?: LegendKeyboardNavigationOptions;
*
*/
@JSProperty("keyboardNavigation")
void setKeyboardNavigation(LegendKeyboardNavigationOptions value);
/**
* (Highcharts, Highstock, Highmaps) A format string for each legend label.
* Available variables relates to properties on the series, or the point in
* case of pies.
*
* @see https://api.highcharts.com/highcharts/legend.labelFormat
* @see https://api.highcharts.com/highstock/legend.labelFormat
* @see https://api.highcharts.com/highmaps/legend.labelFormat
*
* @implspec labelFormat?: string;
*
*/
@JSProperty("labelFormat")
@Nullable
String getLabelFormat();
/**
* (Highcharts, Highstock, Highmaps) A format string for each legend label.
* Available variables relates to properties on the series, or the point in
* case of pies.
*
* @see https://api.highcharts.com/highcharts/legend.labelFormat
* @see https://api.highcharts.com/highstock/legend.labelFormat
* @see https://api.highcharts.com/highmaps/legend.labelFormat
*
* @implspec labelFormat?: string;
*
*/
@JSProperty("labelFormat")
void setLabelFormat(String value);
/**
* (Highcharts, Highstock, Highmaps) Callback function to format each of the
* series' labels. The this keyword refers to the series object, or the
* point object in case of pie charts. By default the series or point name
* is printed.
*
* @see https://api.highcharts.com/highcharts/legend.labelFormatter
* @see https://api.highcharts.com/highstock/legend.labelFormatter
* @see https://api.highcharts.com/highmaps/legend.labelFormatter
*
* @implspec labelFormatter?: object;
*
*/
@JSProperty("labelFormatter")
@Nullable
Any getLabelFormatter();
/**
* (Highcharts, Highstock, Highmaps) Callback function to format each of the
* series' labels. The this keyword refers to the series object, or the
* point object in case of pie charts. By default the series or point name
* is printed.
*
* @see https://api.highcharts.com/highcharts/legend.labelFormatter
* @see https://api.highcharts.com/highstock/legend.labelFormatter
* @see https://api.highcharts.com/highmaps/legend.labelFormatter
*
* @implspec labelFormatter?: object;
*
*/
@JSProperty("labelFormatter")
void setLabelFormatter(Any value);
/**
* (Highcharts, Highstock, Highmaps) The layout of the legend items. Can be
* one of horizontal or vertical or proximate. When proximate, the
* legend items will be placed as close as possible to the graphs they're
* representing, except in inverted charts or when the legend position
* doesn't allow it.
*
* @see https://api.highcharts.com/highcharts/legend.layout
* @see https://api.highcharts.com/highstock/legend.layout
* @see https://api.highcharts.com/highmaps/legend.layout
*
* @implspec layout?: ("horizontal"|"proximate"|"vertical");
*
*/
@JSProperty("layout")
@Nullable
Layout getLayout();
/**
* (Highcharts, Highstock, Highmaps) The layout of the legend items. Can be
* one of horizontal or vertical or proximate. When proximate, the
* legend items will be placed as close as possible to the graphs they're
* representing, except in inverted charts or when the legend position
* doesn't allow it.
*
* @see https://api.highcharts.com/highcharts/legend.layout
* @see https://api.highcharts.com/highstock/legend.layout
* @see https://api.highcharts.com/highmaps/legend.layout
*
* @implspec layout?: ("horizontal"|"proximate"|"vertical");
*
*/
@JSProperty("layout")
void setLayout(Layout value);
/**
* (Highcharts, Gantt) Line height for the legend items. Deprecated as of
* 2.1. Instead, the line height for each item can be set using
* itemStyle.lineHeight, and the padding between items using itemMarginTop
* and itemMarginBottom.
*
* @see https://api.highcharts.com/highcharts/legend.lineHeight
* @see https://api.highcharts.com/gantt/legend.lineHeight
*
* @implspec lineHeight?: number;
*
*/
@JSProperty("lineHeight")
double getLineHeight();
/**
* (Highcharts, Gantt) Line height for the legend items. Deprecated as of
* 2.1. Instead, the line height for each item can be set using
* itemStyle.lineHeight, and the padding between items using itemMarginTop
* and itemMarginBottom.
*
* @see https://api.highcharts.com/highcharts/legend.lineHeight
* @see https://api.highcharts.com/gantt/legend.lineHeight
*
* @implspec lineHeight?: number;
*
*/
@JSProperty("lineHeight")
void setLineHeight(double value);
/**
* (Highcharts, Highstock, Highmaps) If the plot area sized is calculated
* automatically and the legend is not floating, the legend margin is the
* space between the legend and the axis labels or plot area.
*
* @see https://api.highcharts.com/highcharts/legend.margin
* @see https://api.highcharts.com/highstock/legend.margin
* @see https://api.highcharts.com/highmaps/legend.margin
*
* @implspec margin?: number;
*
*/
@JSProperty("margin")
double getMargin();
/**
* (Highcharts, Highstock, Highmaps) If the plot area sized is calculated
* automatically and the legend is not floating, the legend margin is the
* space between the legend and the axis labels or plot area.
*
* @see https://api.highcharts.com/highcharts/legend.margin
* @see https://api.highcharts.com/highstock/legend.margin
* @see https://api.highcharts.com/highmaps/legend.margin
*
* @implspec margin?: number;
*
*/
@JSProperty("margin")
void setMargin(double value);
/**
* (Highcharts, Highstock, Highmaps) Maximum pixel height for the legend.
* When the maximum height is extended, navigation will show.
*
* @see https://api.highcharts.com/highcharts/legend.maxHeight
* @see https://api.highcharts.com/highstock/legend.maxHeight
* @see https://api.highcharts.com/highmaps/legend.maxHeight
*
* @implspec maxHeight?: number;
*
*/
@JSProperty("maxHeight")
double getMaxHeight();
/**
* (Highcharts, Highstock, Highmaps) Maximum pixel height for the legend.
* When the maximum height is extended, navigation will show.
*
* @see https://api.highcharts.com/highcharts/legend.maxHeight
* @see https://api.highcharts.com/highstock/legend.maxHeight
* @see https://api.highcharts.com/highmaps/legend.maxHeight
*
* @implspec maxHeight?: number;
*
*/
@JSProperty("maxHeight")
void setMaxHeight(double value);
/**
* (Highcharts, Highstock, Highmaps) Options for the paging or navigation
* appearing when the legend is overflown. Navigation works well on screen,
* but not in static exported images. One way of working around that is to
* increase the chart height in export.
*
* @see https://api.highcharts.com/highcharts/legend.navigation
* @see https://api.highcharts.com/highstock/legend.navigation
* @see https://api.highcharts.com/highmaps/legend.navigation
*
* @implspec navigation?: LegendNavigationOptions;
*
*/
@JSProperty("navigation")
@Nullable
LegendNavigationOptions getNavigation();
/**
* (Highcharts, Highstock, Highmaps) Options for the paging or navigation
* appearing when the legend is overflown. Navigation works well on screen,
* but not in static exported images. One way of working around that is to
* increase the chart height in export.
*
* @see https://api.highcharts.com/highcharts/legend.navigation
* @see https://api.highcharts.com/highstock/legend.navigation
* @see https://api.highcharts.com/highmaps/legend.navigation
*
* @implspec navigation?: LegendNavigationOptions;
*
*/
@JSProperty("navigation")
void setNavigation(LegendNavigationOptions value);
/**
* (Highcharts, Highstock, Highmaps) The inner padding of the legend box.
*
* @see https://api.highcharts.com/highcharts/legend.padding
* @see https://api.highcharts.com/highstock/legend.padding
* @see https://api.highcharts.com/highmaps/legend.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
double getPadding();
/**
* (Highcharts, Highstock, Highmaps) The inner padding of the legend box.
*
* @see https://api.highcharts.com/highcharts/legend.padding
* @see https://api.highcharts.com/highstock/legend.padding
* @see https://api.highcharts.com/highmaps/legend.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
void setPadding(double value);
/**
* (Highcharts, Highstock, Highmaps) Whether to reverse the order of the
* legend items compared to the order of the series or points as defined in
* the configuration object.
*
* @see https://api.highcharts.com/highcharts/legend.reversed
* @see https://api.highcharts.com/highstock/legend.reversed
* @see https://api.highcharts.com/highmaps/legend.reversed
*
* @implspec reversed?: boolean;
*
*/
@JSProperty("reversed")
boolean getReversed();
/**
* (Highcharts, Highstock, Highmaps) Whether to reverse the order of the
* legend items compared to the order of the series or points as defined in
* the configuration object.
*
* @see https://api.highcharts.com/highcharts/legend.reversed
* @see https://api.highcharts.com/highstock/legend.reversed
* @see https://api.highcharts.com/highmaps/legend.reversed
*
* @implspec reversed?: boolean;
*
*/
@JSProperty("reversed")
void setReversed(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to show the symbol on the right
* side of the text rather than the left side. This is common in Arabic and
* Hebraic.
*
* @see https://api.highcharts.com/highcharts/legend.rtl
* @see https://api.highcharts.com/highstock/legend.rtl
* @see https://api.highcharts.com/highmaps/legend.rtl
*
* @implspec rtl?: boolean;
*
*/
@JSProperty("rtl")
boolean getRtl();
/**
* (Highcharts, Highstock, Highmaps) Whether to show the symbol on the right
* side of the text rather than the left side. This is common in Arabic and
* Hebraic.
*
* @see https://api.highcharts.com/highcharts/legend.rtl
* @see https://api.highcharts.com/highstock/legend.rtl
* @see https://api.highcharts.com/highmaps/legend.rtl
*
* @implspec rtl?: boolean;
*
*/
@JSProperty("rtl")
void setRtl(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* legend. A backgroundColor also needs to be applied for this to take
* effect. The shadow can be an object configuration containing color,
* offsetX, offsetY, opacity and width.
*
* @see https://api.highcharts.com/highcharts/legend.shadow
* @see https://api.highcharts.com/highstock/legend.shadow
* @see https://api.highcharts.com/highmaps/legend.shadow
*
* @implspec shadow?: (boolean|CSSObject);
*
*/
@JSProperty("shadow")
@Nullable
Unknown getShadow();
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* legend. A backgroundColor also needs to be applied for this to take
* effect. The shadow can be an object configuration containing color,
* offsetX, offsetY, opacity and width.
*
* @see https://api.highcharts.com/highcharts/legend.shadow
* @see https://api.highcharts.com/highstock/legend.shadow
* @see https://api.highcharts.com/highmaps/legend.shadow
*
* @implspec shadow?: (boolean|CSSObject);
*
*/
@JSProperty("shadow")
void setShadow(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Whether to apply a drop shadow to the
* legend. A backgroundColor also needs to be applied for this to take
* effect. The shadow can be an object configuration containing color,
* offsetX, offsetY, opacity and width.
*
* @see https://api.highcharts.com/highcharts/legend.shadow
* @see https://api.highcharts.com/highstock/legend.shadow
* @see https://api.highcharts.com/highmaps/legend.shadow
*
* @implspec shadow?: (boolean|CSSObject);
*
*/
@JSProperty("shadow")
void setShadow(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) When this is true, the legend symbol
* width will be the same as the symbol height, which in turn defaults to
* the font size of the legend items.
*
* @see https://api.highcharts.com/highcharts/legend.squareSymbol
* @see https://api.highcharts.com/highstock/legend.squareSymbol
* @see https://api.highcharts.com/highmaps/legend.squareSymbol
*
* @implspec squareSymbol?: boolean;
*
*/
@JSProperty("squareSymbol")
boolean getSquareSymbol();
/**
* (Highcharts, Highstock, Highmaps) When this is true, the legend symbol
* width will be the same as the symbol height, which in turn defaults to
* the font size of the legend items.
*
* @see https://api.highcharts.com/highcharts/legend.squareSymbol
* @see https://api.highcharts.com/highstock/legend.squareSymbol
* @see https://api.highcharts.com/highmaps/legend.squareSymbol
*
* @implspec squareSymbol?: boolean;
*
*/
@JSProperty("squareSymbol")
void setSquareSymbol(boolean value);
/**
* (Highcharts, Highstock) CSS styles for the legend area. In the 1.x
* versions the position of the legend area was determined by CSS. In 2.x,
* the position is determined by properties like align, verticalAlign,
* x and y, but the styles are still parsed for backwards compatibility.
*
* @see https://api.highcharts.com/highcharts/legend.style
* @see https://api.highcharts.com/highstock/legend.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highcharts, Highstock) CSS styles for the legend area. In the 1.x
* versions the position of the legend area was determined by CSS. In 2.x,
* the position is determined by properties like align, verticalAlign,
* x and y, but the styles are still parsed for backwards compatibility.
*
* @see https://api.highcharts.com/highcharts/legend.style
* @see https://api.highcharts.com/highstock/legend.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) The pixel height of the symbol for
* series types that use a rectangle in the legend. Defaults to the font
* size of legend items.
*
* @see https://api.highcharts.com/highcharts/legend.symbolHeight
* @see https://api.highcharts.com/highstock/legend.symbolHeight
* @see https://api.highcharts.com/highmaps/legend.symbolHeight
*
* @implspec symbolHeight?: number;
*
*/
@JSProperty("symbolHeight")
double getSymbolHeight();
/**
* (Highcharts, Highstock, Highmaps) The pixel height of the symbol for
* series types that use a rectangle in the legend. Defaults to the font
* size of legend items.
*
* @see https://api.highcharts.com/highcharts/legend.symbolHeight
* @see https://api.highcharts.com/highstock/legend.symbolHeight
* @see https://api.highcharts.com/highmaps/legend.symbolHeight
*
* @implspec symbolHeight?: number;
*
*/
@JSProperty("symbolHeight")
void setSymbolHeight(double value);
/**
* (Highcharts, Highstock, Highmaps) The pixel padding between the legend
* item symbol and the legend item text.
*
* @see https://api.highcharts.com/highcharts/legend.symbolPadding
* @see https://api.highcharts.com/highstock/legend.symbolPadding
* @see https://api.highcharts.com/highmaps/legend.symbolPadding
*
* @implspec symbolPadding?: number;
*
*/
@JSProperty("symbolPadding")
double getSymbolPadding();
/**
* (Highcharts, Highstock, Highmaps) The pixel padding between the legend
* item symbol and the legend item text.
*
* @see https://api.highcharts.com/highcharts/legend.symbolPadding
* @see https://api.highcharts.com/highstock/legend.symbolPadding
* @see https://api.highcharts.com/highmaps/legend.symbolPadding
*
* @implspec symbolPadding?: number;
*
*/
@JSProperty("symbolPadding")
void setSymbolPadding(double value);
/**
* (Highcharts, Highstock, Highmaps) The border radius of the symbol for
* series types that use a rectangle in the legend. Defaults to half the
* symbolHeight.
*
* @see https://api.highcharts.com/highcharts/legend.symbolRadius
* @see https://api.highcharts.com/highstock/legend.symbolRadius
* @see https://api.highcharts.com/highmaps/legend.symbolRadius
*
* @implspec symbolRadius?: number;
*
*/
@JSProperty("symbolRadius")
double getSymbolRadius();
/**
* (Highcharts, Highstock, Highmaps) The border radius of the symbol for
* series types that use a rectangle in the legend. Defaults to half the
* symbolHeight.
*
* @see https://api.highcharts.com/highcharts/legend.symbolRadius
* @see https://api.highcharts.com/highstock/legend.symbolRadius
* @see https://api.highcharts.com/highmaps/legend.symbolRadius
*
* @implspec symbolRadius?: number;
*
*/
@JSProperty("symbolRadius")
void setSymbolRadius(double value);
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the legend item
* symbol. When the squareSymbol option is set, this defaults to the
* symbolHeight, otherwise 16.
*
* @see https://api.highcharts.com/highcharts/legend.symbolWidth
* @see https://api.highcharts.com/highstock/legend.symbolWidth
* @see https://api.highcharts.com/highmaps/legend.symbolWidth
*
* @implspec symbolWidth?: number;
*
*/
@JSProperty("symbolWidth")
double getSymbolWidth();
/**
* (Highcharts, Highstock, Highmaps) The pixel width of the legend item
* symbol. When the squareSymbol option is set, this defaults to the
* symbolHeight, otherwise 16.
*
* @see https://api.highcharts.com/highcharts/legend.symbolWidth
* @see https://api.highcharts.com/highstock/legend.symbolWidth
* @see https://api.highcharts.com/highmaps/legend.symbolWidth
*
* @implspec symbolWidth?: number;
*
*/
@JSProperty("symbolWidth")
void setSymbolWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) A title to be added on top of the
* legend.
*
* @see https://api.highcharts.com/highcharts/legend.title
* @see https://api.highcharts.com/highstock/legend.title
* @see https://api.highcharts.com/highmaps/legend.title
*
* @implspec title?: LegendTitleOptions;
*
*/
@JSProperty("title")
@Nullable
LegendTitleOptions getTitle();
/**
* (Highcharts, Highstock, Highmaps) A title to be added on top of the
* legend.
*
* @see https://api.highcharts.com/highcharts/legend.title
* @see https://api.highcharts.com/highstock/legend.title
* @see https://api.highcharts.com/highmaps/legend.title
*
* @implspec title?: LegendTitleOptions;
*
*/
@JSProperty("title")
void setTitle(LegendTitleOptions value);
/**
* (Highcharts, Highstock, Highmaps) Whether to use HTML to render the
* legend item texts.
*
* Prior to 4.1.7, when using HTML, legend.navigation was disabled.
*
* @see https://api.highcharts.com/highcharts/legend.useHTML
* @see https://api.highcharts.com/highstock/legend.useHTML
* @see https://api.highcharts.com/highmaps/legend.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
boolean getUseHTML();
/**
* (Highcharts, Highstock, Highmaps) Whether to use HTML to render the
* legend item texts.
*
* Prior to 4.1.7, when using HTML, legend.navigation was disabled.
*
* @see https://api.highcharts.com/highcharts/legend.useHTML
* @see https://api.highcharts.com/highstock/legend.useHTML
* @see https://api.highcharts.com/highmaps/legend.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
void setUseHTML(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The vertical alignment of the legend
* box. Can be one of top, middle or bottom. Vertical position can be
* further determined by the y option.
*
* In the case that the legend is aligned in a corner position, the layout
* option will determine whether to place it above/below or on the side of
* the plot area.
*
* When the layout option is proximate, the verticalAlign option doesn't
* apply.
*
* @see https://api.highcharts.com/highcharts/legend.verticalAlign
* @see https://api.highcharts.com/highstock/legend.verticalAlign
* @see https://api.highcharts.com/highmaps/legend.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
@Nullable
VerticalAlign getVerticalAlign();
/**
* (Highcharts, Highstock, Highmaps) The vertical alignment of the legend
* box. Can be one of top, middle or bottom. Vertical position can be
* further determined by the y option.
*
* In the case that the legend is aligned in a corner position, the layout
* option will determine whether to place it above/below or on the side of
* the plot area.
*
* When the layout option is proximate, the verticalAlign option doesn't
* apply.
*
* @see https://api.highcharts.com/highcharts/legend.verticalAlign
* @see https://api.highcharts.com/highstock/legend.verticalAlign
* @see https://api.highcharts.com/highmaps/legend.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
void setVerticalAlign(VerticalAlign value);
/**
* (Highcharts, Highstock, Highmaps) The width of the legend box.
*
* @see https://api.highcharts.com/highcharts/legend.width
* @see https://api.highcharts.com/highstock/legend.width
* @see https://api.highcharts.com/highmaps/legend.width
*
* @implspec width?: number;
*
*/
@JSProperty("width")
double getWidth();
/**
* (Highcharts, Highstock, Highmaps) The width of the legend box.
*
* @see https://api.highcharts.com/highcharts/legend.width
* @see https://api.highcharts.com/highstock/legend.width
* @see https://api.highcharts.com/highmaps/legend.width
*
* @implspec width?: number;
*
*/
@JSProperty("width")
void setWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) The x offset of the legend relative to
* its horizontal alignment align within chart.spacingLeft and
* chart.spacingRight. Negative x moves it to the left, positive x moves it
* to the right.
*
* @see https://api.highcharts.com/highcharts/legend.x
* @see https://api.highcharts.com/highstock/legend.x
* @see https://api.highcharts.com/highmaps/legend.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highcharts, Highstock, Highmaps) The x offset of the legend relative to
* its horizontal alignment align within chart.spacingLeft and
* chart.spacingRight. Negative x moves it to the left, positive x moves it
* to the right.
*
* @see https://api.highcharts.com/highcharts/legend.x
* @see https://api.highcharts.com/highstock/legend.x
* @see https://api.highcharts.com/highmaps/legend.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highcharts, Highstock, Highmaps) The vertical offset of the legend
* relative to it's vertical alignment verticalAlign within
* chart.spacingTop and chart.spacingBottom. Negative y moves it up,
* positive y moves it down.
*
* @see https://api.highcharts.com/highcharts/legend.y
* @see https://api.highcharts.com/highstock/legend.y
* @see https://api.highcharts.com/highmaps/legend.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
double getY();
/**
* (Highcharts, Highstock, Highmaps) The vertical offset of the legend
* relative to it's vertical alignment verticalAlign within
* chart.spacingTop and chart.spacingBottom. Negative y moves it up,
* positive y moves it down.
*
* @see https://api.highcharts.com/highcharts/legend.y
* @see https://api.highcharts.com/highstock/legend.y
* @see https://api.highcharts.com/highmaps/legend.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
void setY(double value);
/**
*/
abstract class Align extends JsEnum {
public static final Align CENTER = JsEnum.of("center");
public static final Align LEFT = JsEnum.of("left");
public static final Align RIGHT = JsEnum.of("right");
}
/**
*/
abstract class Layout extends JsEnum {
public static final Layout HORIZONTAL = JsEnum.of("horizontal");
public static final Layout PROXIMATE = JsEnum.of("proximate");
public static final Layout VERTICAL = JsEnum.of("vertical");
}
/**
*/
abstract class VerticalAlign extends JsEnum {
public static final VerticalAlign BOTTOM = JsEnum.of("bottom");
public static final VerticalAlign MIDDLE = JsEnum.of("middle");
public static final VerticalAlign TOP = JsEnum.of("top");
}
}