Package software.xdev.chartjs.model.options

Class Options<T extends Options<T,A>,A extends Animation<A>>

java.lang.Object
software.xdev.chartjs.model.options.Options<T,A>
Direct Known Subclasses:
BarOptions, BubbleOptions, DoughnutOptions, LineOptions, PieOptions, PolarOptions, RadarOptions
public class Options<T extends Options<T,A>,A extends Animation<A>> extends Object
See Also:

  • Field Details

  • Constructor Details

    • Options

      public Options()

  • Method Details

    • getScales

      public Scales getScales()

    • setScales

      public T setScales(Scales scales)

    • getIndexAxis

      public IndexAxis getIndexAxis()

    • setIndexAxis

      public T setIndexAxis(IndexAxis indexAxis)

    • getResponsive

      public Boolean getResponsive()
      See Also:

    • setResponsive

      public T setResponsive(Boolean responsive)
      Default true Resizes when the canvas container does.

    • getAnimation

      public Boolean getAnimation()
      See Also:

    • setAnimation

      public T setAnimation(Boolean animation)
      Default true Disables the Animation completely if set to false.

    • getResponsiveAnimationDuration

      public Integer getResponsiveAnimationDuration()
      See Also:

    • setResponsiveAnimationDuration

      public T setResponsiveAnimationDuration(Integer responsiveAnimationDuration)
      Default 0 Duration in milliseconds it takes to animate to new size after a resize event.

    • getMaintainAspectRatio

      public Boolean getMaintainAspectRatio()
      See Also:

    • setMaintainAspectRatio

      public T setMaintainAspectRatio(Boolean maintainAspectRatio)
      Default true Maintain the original canvas aspect ratio (width / height) when resizing

    • getEvents

      public Set<String> getEvents()
      See Also:

    • setEvents

      public T setEvents(Collection<String> events)
      Default ["mousemove", "mouseout", "click", "touchstart", "touchmove", "touchend"] Events that the chart should listen to for tooltips and hovering

    • getOnClick

      public JavaScriptFunction getOnClick()
      See Also:

    • setOnClick

      public T setOnClick(JavaScriptFunction onClick)
      Default null Called if the event is of type 'mouseup' or 'click'. Called in the context of the chart and passed an array of active arcElements

    • getLegendCallback

      public JavaScriptFunction getLegendCallback()
      See Also:

    • setLegendCallback

      public T setLegendCallback(JavaScriptFunction legendCallback)
      Default function (chart) { } Function to generate a legend. Receives the chart object to generate a legend from. Default implementation returns an HTML string.

    • getOnResize

      public JavaScriptFunction getOnResize()
      See Also:

    • setOnResize

      public T setOnResize(JavaScriptFunction onResize)
      Default null Called when a resize occurs. Gets passed two arguemnts: the chart instance and the new size.

    • getInteraction

      public CoreInteractionOptions getInteraction()

    • setInteraction

      public T setInteraction(CoreInteractionOptions interaction)

    • getHover

      public CoreInteractionOptions getHover()

    • setHover

      public T setHover(CoreInteractionOptions hover)
      The hover configuration is passed into the options.hover namespace. The global hover configuration is at Chart.defaults.global.hover.

    • getAnimations

      public Animations<A> getAnimations()
      See Also:

    • setAnimations

      public T setAnimations(Animations<A> animations)
      The following animation options are available. The global options for are defined in Chart.defaults.global.animation.

    • getLayout

      public Layout getLayout()
      Returns:
      Layout instance or null

    • setLayout

      public T setLayout(Layout layout)
      Parameters:
      layout - Layout instance or null
      Returns:
      this instance for chaining

    • getPlugins

      public Plugins getPlugins()
      See Also:

    • setPlugins

      public T setPlugins(Plugins plugins)
      A placeholder in which configuration options for plugins may be passed.
      Parameters:
      plugins - Object or null
      Returns:
      this instance for chaining

    • self

      protected T self()