Package org.pepstock.charba.client.configuration

Class AxisBorder

  • public class AxisBorder
extends Object
    Defines options for the border that run perpendicular to the axis.
    Author:
    Andrea "Stock" Stocchero

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Axis getAxis()
      Returns the axis instance.
      IsColor getColor()
      If set, used as the color of the border line.
      If unset, the first color option is resolved and used.
      String getColorAsString()
      If set, used as the color of the border line.
      If unset, the first color option is resolved and used.
      List<Integer> getDash()
      Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
      BorderDashCallback<ScaleContext> getDashCallback()
      Returns the border dash callback instance.
      double getDashOffset()
      Returns the line dash pattern offset.
      BorderDashOffsetCallback<ScaleContext> getDashOffsetCallback()
      Returns the border dash offset callback instance.
      int getWidth()
      If set, used as the width of the border line.
      If unset, the first lineWidth option is resolved and used.
      int getZ()
      Returns z-index of border layer.
      Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
      boolean isDisplay()
      If true, draw border at the edge between the axis and the chart area.
      void setColor​(String color)
      If set, used as the color of the border line.
      If unset, the first color option is resolved and used.
      void setColor​(IsColor color)
      If set, used as the color of the border line.
      If unset, the first color option is resolved and used.
      void setDash​(int... borderDash)
      Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
      void setDash​(BorderDashCallback<ScaleContext> borderDashCallback)
      Sets the border dash callback instance.
      void setDash​(NativeCallback borderDashCallback)
      Sets the border dash callback instance.
      void setDashOffset​(double borderDashOffset)
      Sets the line dash pattern offset.
      void setDashOffset​(BorderDashOffsetCallback<ScaleContext> borderDashOffsetCallback)
      Sets the border dash offset callback instance.
      void setDashOffset​(NativeCallback borderDashOffsetCallback)
      Sets the border dash offset callback instance.
      void setDisplay​(boolean display)
      If true, draw border at the edge between the axis and the chart area.
      void setWidth​(int borderWidth)
      If set, used as the width of the border line.
      If unset, the first lineWidth option is resolved and used.
      void setZ​(int z)
      Sets z-index of border layer.
      Values less than or equals to 0 are drawn under datasets, greater than 0 on top.

    • Method Detail

      • setDisplay

        public void setDisplay​(boolean display)
        If true, draw border at the edge between the axis and the chart area.
        Parameters:
        display - If true, draw border at the edge between the axis and the chart area.

      • isDisplay

        public boolean isDisplay()
        If true, draw border at the edge between the axis and the chart area.
        Returns:
        If true, draw border at the edge between the axis and the chart area.

      • setColor

        public void setColor​(IsColor color)
        If set, used as the color of the border line.
        If unset, the first color option is resolved and used.
        Parameters:
        color - if set, used as the color of the border line.
        If unset, the first color option is resolved and used.

      • setColor

        public void setColor​(String color)
        If set, used as the color of the border line.
        If unset, the first color option is resolved and used.
        Parameters:
        color - if set, used as the color of the border line.
        If unset, the first color option is resolved and used.

      • getColorAsString

        public String getColorAsString()
        If set, used as the color of the border line.
        If unset, the first color option is resolved and used.
        Returns:
        if set, used as the color of the border line.
        If unset, the first color option is resolved and used.

      • getColor

        public IsColor getColor()
        If set, used as the color of the border line.
        If unset, the first color option is resolved and used.
        Returns:
        if set, used as the color of the border line.
        If unset, the first color option is resolved and used.

      • setWidth

        public void setWidth​(int borderWidth)
        If set, used as the width of the border line.
        If unset, the first lineWidth option is resolved and used.
        Parameters:
        borderWidth - if set, used as the width of the border line.
        If unset, the first lineWidth option is resolved and used.

      • getWidth

        public int getWidth()
        If set, used as the width of the border line.
        If unset, the first lineWidth option is resolved and used.
        Returns:
        if set, used as the width of the border line.
        If unset, the first lineWidth option is resolved and used.

      • setDash

        public void setDash​(int... borderDash)
        Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
        Parameters:
        borderDash - the line dash pattern used when stroking lines

      • getDash

        public List<Integer> getDash()
        Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
        Returns:
        the line dash pattern used when stroking lines.

      • setDashOffset

        public void setDashOffset​(double borderDashOffset)
        Sets the line dash pattern offset.
        Parameters:
        borderDashOffset - Offset for line dashes.

      • getDashOffset

        public double getDashOffset()
        Returns the line dash pattern offset.
        Returns:
        Offset for line dashes.

      • setZ

        public void setZ​(int z)
        Sets z-index of border layer.
        Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
        Parameters:
        z - z-index of border layer.
        Values less than or equals to 0 are drawn under datasets, greater than 0 on top.

      • getZ

        public int getZ()
        Returns z-index of border layer.
        Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
        Returns:
        z-index of border layer.
        Values less than or equals to 0 are drawn under datasets, greater than 0 on top.

      • getDashOffsetCallback

        public BorderDashOffsetCallback<ScaleContext> getDashOffsetCallback()
        Returns the border dash offset callback instance.
        Returns:
        the border dash offset callback instance

      • setDashOffset

        public void setDashOffset​(BorderDashOffsetCallback<ScaleContext> borderDashOffsetCallback)
        Sets the border dash offset callback instance.
        Parameters:
        borderDashOffsetCallback - the border dash offset callback instance

      • setDashOffset

        public void setDashOffset​(NativeCallback borderDashOffsetCallback)
        Sets the border dash offset callback instance.
        Parameters:
        borderDashOffsetCallback - the border dash offset callback instance

      • getDashCallback

        public BorderDashCallback<ScaleContext> getDashCallback()
        Returns the border dash callback instance.
        Returns:
        the border dash callback instance

      • setDash

        public void setDash​(BorderDashCallback<ScaleContext> borderDashCallback)
        Sets the border dash callback instance.
        Parameters:
        borderDashCallback - the border dash callback instance

      • setDash

        public void setDash​(NativeCallback borderDashCallback)
        Sets the border dash callback instance.
        Parameters:
        borderDashCallback - the border dash callback instance

      • getAxis

        public final Axis getAxis()
        Returns the axis instance.
        Returns:
        the axis