Package io.jmix.mapsui.component

Interface CanvasLayer.Polyline

All Superinterfaces:
CanvasLayer.Geometry
Enclosing interface:
CanvasLayer
public static interface CanvasLayer.Polyline extends CanvasLayer.Geometry
A wrapper class encapsulating LineString on the canvas.

  • Method Details

    • getGeometry

      org.locationtech.jts.geom.LineString getGeometry()
      Returns a JTS linestring.
      Specified by:
      getGeometry in interface CanvasLayer.Geometry

    • setStyle

      CanvasLayer.Polyline setStyle(PolylineStyle style)
      Applies a style to the polyline.
      Parameters:
      style - polyline style
      Returns:
      current polyline. Useful for a fluent API.

    • setPopupContent

      CanvasLayer.Polyline setPopupContent(String popupContent)
      Adds a popup window to be opened as user clicks on the polyline.
      Parameters:
      popupContent - content of the popup window
      Returns:
      current polyline. Useful for a fluent API.

    • setPopupOptions

      CanvasLayer.Polyline setPopupOptions(PopupWindowOptions options)
      Specifies options for a popup window added by setPopupContent(String).
      Parameters:
      options - popup window options
      Returns:
      current polyline. Useful for a fluent API.

    • setTooltipContent

      CanvasLayer.Polyline setTooltipContent(String tooltipContent)
      Adds a tooltip to be opened as user hovers on the polyline.
      Parameters:
      tooltipContent - content of the tooltip box
      Returns:
      current polyline. Useful for a fluent API.

    • setTooltipOptions

      CanvasLayer.Polyline setTooltipOptions(TooltipOptions options)
      Specifies options for a tooltip added by setTooltipContent(String).
      Parameters:
      options - tooltip options
      Returns:
      current polyline. Useful for a fluent API.

    • setEditable

      CanvasLayer.Polyline setEditable(boolean editable)
      Description copied from interface: CanvasLayer.Geometry
      Sets whether the geometry is to be modifiable on a canvas.
      Specified by:
      setEditable in interface CanvasLayer.Geometry

    • addClickListener

      Subscription addClickListener(Consumer<CanvasLayer.Polyline.ClickEvent> listener)
      Registers a new polyline click listener.
      Parameters:
      listener - the listener to be added
      Returns:
      a registration object for removing an event listener added to a source

    • addRightClickListener

      Subscription addRightClickListener(Consumer<CanvasLayer.Polyline.RightClickEvent> listener)
      Registers a new polyline right click listener.
      Parameters:
      listener - the listener to be added
      Returns:
      a registration object for removing an event listener added to a source

    • addModifiedListener

      Subscription addModifiedListener(Consumer<CanvasLayer.Polyline.ModifiedEvent> listener)
      Registers a new polyline modified listener.
      Parameters:
      listener - the listener to be added
      Returns:
      a registration object for removing an event listener added to a source