HINavigation

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HINavigation

public class HINavigation
extends HIFoundation

Constructor Summary

Constructors
Constructor and Description

HINavigation()

Constructors
Constructor and Description
`HINavigation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIColor`	`getActiveColor()`
`HIAnimationOptionsObject`	`getAnimation()`
`HIAnnotationsOptions`	`getAnnotationsOptions()`
`java.lang.Number`	`getArrowSize()`
`HIBindings`	`getBindings()`
`java.lang.String`	`getBindingsClassName()`
`HIBreadcrumbs`	`getBreadcrumbs()`
`HIButtonOptions`	`getButtonOptions()`
`java.lang.Boolean`	`getEnabled()`
`HIEvents`	`getEvents()`
`java.lang.String`	`getIconsURL()`
`HIColor`	`getInactiveColor()`
`HICSSObject`	`getMenuItemHoverStyle()`
`HICSSObject`	`getMenuItemStyle()`
`HICSSObject`	`getMenuStyle()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`HIPopup`	`getPopup()`
`HICSSObject`	`getStyle()`
`void`	`setActiveColor(HIColor activeColor)` The color for the active up or down arrow in the legend page navigation.
`void`	`setAnimation(HIAnimationOptionsObject animation)` How to animate the pages when navigating up or down.
`void`	`setAnnotationsOptions(HIAnnotationsOptions annotationsOptions)` Additional options to be merged into all annotations.
`void`	`setArrowSize(java.lang.Number arrowSize)` The pixel size of the up and down arrows in the legend paging navigation.
`void`	`setBindings(HIBindings bindings)` Bindings definitions for custom HTML buttons.
`void`	`setBindingsClassName(java.lang.String bindingsClassName)` A CSS class name where all bindings will be attached to.
`void`	`setBreadcrumbs(HIBreadcrumbs breadcrumbs)` Options for breadcrumbs.
`void`	`setButtonOptions(HIButtonOptions buttonOptions)` A collection of options for buttons appearing in the exporting module.
`void`	`setEnabled(java.lang.Boolean enabled)` Whether to enable the legend navigation.
`void`	`setEvents(HIEvents events)` Events to communicate between Stock Tools and custom GUI.
`void`	`setIconsURL(java.lang.String iconsURL)` Path where Highcharts will look for icons.
`void`	`setInactiveColor(HIColor inactiveColor)` The color of the inactive up or down arrow in the legend page navigation. .
`void`	`setMenuItemHoverStyle(HICSSObject menuItemHoverStyle)` CSS styles for the hover state of the individual items within the popup menu appearing by defaults when the export icon is clicked.
`void`	`setMenuItemStyle(HICSSObject menuItemStyle)` CSS styles for the individual items within the popup menu appearing by defaults when the export icon is clicked.
`void`	`setMenuStyle(HICSSObject menuStyle)` CSS styles for the popup menu appearing by defaults when the export icon is clicked.
`void`	`setPopup(HIPopup popup)` Translations for all field names used in popup.
`void`	`setStyle(HICSSObject style)` Text styles for the legend page navigation.

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HINavigation
```
public HINavigation()
```
- Method Detail
  - getActiveColor
```
public HIColor getActiveColor()
```
  - getAnimation
```
public HIAnimationOptionsObject getAnimation()
```
  - getAnnotationsOptions
```
public HIAnnotationsOptions getAnnotationsOptions()
```
  - getArrowSize
```
public java.lang.Number getArrowSize()
```
  - getBindings
```
public HIBindings getBindings()
```
  - getBindingsClassName
```
public java.lang.String getBindingsClassName()
```
  - getBreadcrumbs
```
public HIBreadcrumbs getBreadcrumbs()
```
  - getButtonOptions
```
public HIButtonOptions getButtonOptions()
```
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
  - getEvents
```
public HIEvents getEvents()
```
  - getIconsURL
```
public java.lang.String getIconsURL()
```
  - getInactiveColor
```
public HIColor getInactiveColor()
```
  - getMenuItemHoverStyle
```
public HICSSObject getMenuItemHoverStyle()
```
  - getMenuItemStyle
```
public HICSSObject getMenuItemStyle()
```
  - getMenuStyle
```
public HICSSObject getMenuStyle()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Specified by:
    
    getParams in class HIFoundation
  - getPopup
```
public HIPopup getPopup()
```
  - getStyle
```
public HICSSObject getStyle()
```
  - setActiveColor
```
public void setActiveColor(HIColor activeColor)
```
    The color for the active up or down arrow in the legend page navigation.
    
    defaults:
    
    #0022ff
  - setAnimation
```
public void setAnimation(HIAnimationOptionsObject animation)
```
    How to animate the pages when navigating up or down. A value of `true` applies the defaults navigation given in the `chart.animation` option. Additional options can be given as an object containing values for easing and duration.
    
    defaults:
    
    true
  - setAnnotationsOptions
```
public void setAnnotationsOptions(HIAnnotationsOptions annotationsOptions)
```
    Additional options to be merged into all annotations.
  - setArrowSize
```
public void setArrowSize(java.lang.Number arrowSize)
```
    The pixel size of the up and down arrows in the legend paging navigation.
    
    defaults:
    
    12
  - setBindings
```
public void setBindings(HIBindings bindings)
```
    Bindings definitions for custom HTML buttons. Each binding implements simple event-driven interface: - `className`: classname used to bind event to - `init`: initial event, fired on button click - `start`: fired on first click on a chart - `steps`: array of sequential events fired one after another on each of users clicks - `end`: last event to be called after last step event
  - setBindingsClassName
```
public void setBindingsClassName(java.lang.String bindingsClassName)
```
    A CSS class name where all bindings will be attached to. Multiple charts on the same page should have separate class names to prevent duplicating events. Default value of versions < 7.0.4 `highcharts-bindings-wrapper`
    
    defaults:
    
    highcharts-bindings-container
  - setBreadcrumbs
```
public void setBreadcrumbs(HIBreadcrumbs breadcrumbs)
```
    Options for breadcrumbs. Breadcrumbs general options are defined in `navigation.breadcrumbs`. Specific options for drilldown are set in `drilldown.breadcrumbs` and for tree-like series traversing, in `plotOptions[series].breadcrumbs`.
  - setButtonOptions
```
public void setButtonOptions(HIButtonOptions buttonOptions)
```
    A collection of options for buttons appearing in the exporting module. In styled mode, the buttons are styled with the `.highcharts-contextbutton` and `.highcharts-button-symbol` classes.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Whether to enable the legend navigation. In most cases, disabling the navigation results in an unwanted overflow. See also the [adapt chart to legend](https://github.com/highcharts/adapt-chart-to-legend) plugin for a solution to extend the chart height to make room for the legend, optionally in exported charts only.
    
    defaults:
    
    true
  - setEvents
```
public void setEvents(HIEvents events)
```
    Events to communicate between Stock Tools and custom GUI.
  - setIconsURL
```
public void setIconsURL(java.lang.String iconsURL)
```
    Path where Highcharts will look for icons. Change this to use icons from a different server.
  - setInactiveColor
```
public void setInactiveColor(HIColor inactiveColor)
```
    The color of the inactive up or down arrow in the legend page navigation. .
    
    defaults:
    
    #cccccc
  - setMenuItemHoverStyle
```
public void setMenuItemHoverStyle(HICSSObject menuItemHoverStyle)
```
    CSS styles for the hover state of the individual items within the popup menu appearing by defaults when the export icon is clicked. The menu items are rendered in HTML.
    
    defaults:
    
    {"background": "#f2f2f2" }
  - setMenuItemStyle
```
public void setMenuItemStyle(HICSSObject menuItemStyle)
```
    CSS styles for the individual items within the popup menu appearing by defaults when the export icon is clicked. The menu items are rendered in HTML. Font size defaultss to `11px` on desktop and `14px` on touch devices.
    
    defaults:
    
    {"padding": "0.5em", "color": "#333333", "background": "none", "borderRadius": "3px", "fontSize": "0.8em", "transition": "background 250ms, color 250ms"}
  - setMenuStyle
```
public void setMenuStyle(HICSSObject menuStyle)
```
    CSS styles for the popup menu appearing by defaults when the export icon is clicked. This menu is rendered in HTML.
    
    defaults:
    
    {"background": "#ffffff", "borderRadius": "3px", "padding": "0.5em"}
  - setPopup
```
public void setPopup(HIPopup popup)
```
    Translations for all field names used in popup.
  - setStyle
```
public void setStyle(HICSSObject style)
```
    Text styles for the legend page navigation.

Class HINavigation

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HINavigation

Method Detail

getActiveColor

getAnimation

getAnnotationsOptions

getArrowSize

getBindings

getBindingsClassName

getBreadcrumbs

getButtonOptions

getEnabled

getEvents

getIconsURL

getInactiveColor

getMenuItemHoverStyle

getMenuItemStyle

getMenuStyle

getParams

getPopup

getStyle

setActiveColor

setAnimation

setAnnotationsOptions

setArrowSize

setBindings

setBindingsClassName

setBreadcrumbs

setButtonOptions

setEnabled

setEvents

setIconsURL

setInactiveColor

setMenuItemHoverStyle

setMenuItemStyle

setMenuStyle

setPopup

setStyle