Package io.jmix.chartsflowui.kit.component.model.shared

Interface HasSymbols<T>

Type Parameters:
T - origin class type
All Known Implementing Classes:
EffectScatterSeries, LineSeries, MarkLine.Point, MarkPoint, MarkPoint.Point, RadarSeries, ScatterSeries
public interface HasSymbols<T>
A component that has symbols.

  • Method Details

    • getSymbol

      HasSymbols.Symbol getSymbol()
      Returns:
      symbol

    • setSymbol

      void setSymbol(String icon)
      Sets a symbol or replaces an existing one.
      Possible values:
      • image://%url%, example: image://http://example.website/a/b.png
      • image://%dataURI%, example: image://data:image/gif;base64,...
      • path://%svgPathData%, example: path://M30.9,53.2c16...
      Parameters:
      icon - symbol to set

    • setSymbol

      void setSymbol(HasSymbols.SymbolType symbolType)
      Sets predefined symbol type or replaces an existing one.
      Parameters:
      symbolType - symbol to set

    • withSymbol

      default T withSymbol(String icon)
      Parameters:
      icon - symbol to set
      Returns:
      this
      See Also:

    • withSymbol

      default T withSymbol(HasSymbols.SymbolType symbolType)
      Parameters:
      symbolType - symbol to set
      Returns:
      this
      See Also:

    • getSymbolSize

      Integer getSymbolSize()
      Returns:
      symbol size

    • setSymbolSize

      void setSymbolSize(Integer symbolSize)
      Sets a symbol size or replaces an existing one.
      Parameters:
      symbolSize - symbol size to set

    • getSymbolSizeFunction

      JsFunction getSymbolSizeFunction()
      Returns:
      callback function for symbol size

    • setSymbolSizeFunction

      void setSymbolSizeFunction(JsFunction symbolSizeFunction)
      Sets a callback function for symbol size or replaces an existing one.
      Parameters:
      symbolSizeFunction - symbol size callback function

    • setSymbolSizeFunction

      void setSymbolSizeFunction(String symbolSizeFunction)
      Sets a callback function for symbol size as string or replaces an existing one.
      Parameters:
      symbolSizeFunction - formatter function as string

    • withSymbolSizeFunction

      default T withSymbolSizeFunction(JsFunction symbolSizeFunction)
      Parameters:
      symbolSizeFunction - symbol size callback function
      Returns:
      this
      See Also:

    • withSymbolSizeFunction

      default T withSymbolSizeFunction(String symbolSizeFunction)
      Parameters:
      symbolSizeFunction - symbol size callback function as string
      Returns:
      this
      See Also:

    • withSymbolSize

      default T withSymbolSize(Integer symbolSize)
      Parameters:
      symbolSize - symbol size to set
      Returns:
      this
      See Also:

    • getSymbolRotate

      Integer getSymbolRotate()
      Returns:
      rotate degree of symbol

    • setSymbolRotate

      void setSymbolRotate(Integer symbolRotate)
      Sets a rotate degree of symbol or replaces an existing one. The negative value represents clockwise.
      Parameters:
      symbolRotate - rotate symbol to set

    • withSymbolRotate

      default T withSymbolRotate(Integer symbolRotate)
      Parameters:
      symbolRotate - rotate symbol to set
      Returns:
      this
      See Also:

    • getSymbolKeepAspect

      Boolean getSymbolKeepAspect()
      Returns:
      true if the aspect for symbols must be kept, false otherwise

    • setSymbolKeepAspect

      void setSymbolKeepAspect(Boolean symbolKeepAspect)
      Sets the keeping of aspects for a symbol.
      Parameters:
      symbolKeepAspect - whether to keep aspect for symbols in the form of path://%svgPathData%

    • withSymbolKeepAspect

      default T withSymbolKeepAspect(Boolean symbolKeepAspect)
      Parameters:
      symbolKeepAspect - whether to keep aspect for symbols in the form of path://%svgPathData%
      Returns:
      this
      See Also:

    • getSymbolOffset

      String[] getSymbolOffset()
      Returns:
      offset of symbol relative to original position

    • setSymbolOffset

      void setSymbolOffset(String xOffset, String yOffset)
      Sets an offset of symbol relative to original position or replaces an existing one.
      Possible values:
      • Pixel values: hasSymbols.setSymbolOffset("10", "10");.
      • Percentage values: hasSymbols.setSymbolOffset("50%", "45%");.
      • Pixel and percentage values combination: hasSymbols.setSymbolOffset("5", "50%");.
      Parameters:
      xOffset - horizontal offset
      yOffset - vertical offset

    • withSymbolOffset

      default T withSymbolOffset(String xOffset, String yOffset)
      Parameters:
      xOffset - horizontal offset
      yOffset - vertical offset
      Returns:
      this
      See Also: