Class CanvasOverlay

  • All Implemented Interfaces:
    Serializable, Element
    Direct Known Subclasses:
    Line

    public class CanvasOverlay
    extends Object
    implements Element
    CanvasOverlay object. CanvasOverlay properties can be set or overriden by the options passed in from the user.
    Author:
    inaiat
    See Also:
    Serialized Form
    • Constructor Detail

      • CanvasOverlay

        public CanvasOverlay()
        Instantiates a new canvas overlay.
      • CanvasOverlay

        public CanvasOverlay​(String name)
        Instantiates a new canvas overlay.
        Parameters:
        name - the name
    • Method Detail

      • getName

        public String getName()
        Gets the name.
        Returns:
        the name
      • setName

        public void setName​(String name)
        Sets the name.
        Parameters:
        name - the new name
      • getShow

        public Boolean getShow()
        Gets the show.
        Returns:
        the show
      • setShow

        public void setShow​(Boolean show)
        Sets the show.
        Parameters:
        show - the new show
      • getLineWidth

        public Integer getLineWidth()
        Gets the line width.
        Returns:
        lineWidth
      • setLineWidth

        public CanvasOverlay setLineWidth​(Integer lineWidth)
        Sets the line width.
        Parameters:
        lineWidth - the new line width
        Returns:
        CanvasOverlay
      • getLineCap

        public String getLineCap()
        Gets the line cap.
        Returns:
        lineCap
      • setLineCap

        public CanvasOverlay setLineCap​(String lineCap)
        Sets the line cap.
        Parameters:
        lineCap - the new line cap
        Returns:
        CanvasOverlay
      • getColor

        public String getColor()
        Gets the color.
        Returns:
        the color
      • setColor

        public CanvasOverlay setColor​(String color)
        Sets the color.
        Parameters:
        color - the new color
        Returns:
        CanvasOverlay
      • getShadow

        public Boolean getShadow()
        Gets the shadow.
        Returns:
        shadow
      • setShadow

        public CanvasOverlay setShadow​(Boolean shadow)
        Sets the shadow.
        Parameters:
        shadow - the new shadow
        Returns:
        CanvasOverlay
      • getShowTooltip

        public Boolean getShowTooltip()
        Gets the showTooltip.
        Returns:
        the showTooltip
      • setShowTooltip

        public void setShowTooltip​(Boolean showTooltip)
        Sets the showTooltip.
        Parameters:
        showTooltip - the new showTooltip
      • getShowTooltipPrecision

        public Float getShowTooltipPrecision()
        Gets the showTooltipPrecision.
        Returns:
        the showTooltipPrecision
      • setShowTooltipPrecision

        public void setShowTooltipPrecision​(Float showTooltipPrecision)
        Sets the showTooltipPrecision.
        Parameters:
        showTooltipPrecision - the new showTooltipPrecision
      • getTooltipLocation

        public String getTooltipLocation()
        Gets the tooltipLocation.
        Returns:
        the tooltipLocation
      • setTooltipLocation

        public void setTooltipLocation​(String tooltipLocation)
        Sets the tooltipLocation.
        Parameters:
        tooltipLocation - the new tooltipLocation
      • getFadeTooltip

        public Boolean getFadeTooltip()
        Gets the fadeTooltip.
        Returns:
        the fadeTooltip
      • setFadeTooltip

        public void setFadeTooltip​(Boolean fadeTooltip)
        Sets the fadeTooltip.
        Parameters:
        fadeTooltip - the new fadeTooltip
      • getTooltipFadeSpeed

        public String getTooltipFadeSpeed()
        Gets the tooltipFadeSpeed.
        Returns:
        the tooltipFadeSpeed
      • setTooltipFadeSpeed

        public void setTooltipFadeSpeed​(String tooltipFadeSpeed)
        Sets the tooltipFadeSpeed.
        Parameters:
        tooltipFadeSpeed - the new tooltipFadeSpeed
      • getTooltipOffset

        public Integer getTooltipOffset()
        Gets the tooltipOffset.
        Returns:
        the tooltipOffset
      • setTooltipOffset

        public void setTooltipOffset​(Integer tooltipOffset)
        Sets the tooltipOffset.
        Parameters:
        tooltipOffset - the new tooltipOffset
      • getTooltipFormatString

        public String getTooltipFormatString()
        Gets the tooltipFormatString.
        Returns:
        the tooltipFormatString
      • setTooltipFormatString

        public void setTooltipFormatString​(String tooltipFormatString)
        Sets the tooltipFormatString.
        Parameters:
        tooltipFormatString - the new tooltipFormatString
      • getXOffset

        public String getXOffset()
        Gets the xOffset.
        Returns:
        the xOffset
      • setXOffset

        public CanvasOverlay setXOffset​(String xOffset)
        Sets the xOffset.
        Parameters:
        xOffset - the new xOffset
        Returns:
        CanvasOverlay
      • objectsInstance

        public Collection<LineObject> objectsInstance()
        Instantiates the objects.
        Returns:
        the objects