Package io.jmix.mapsui.component
Interface CanvasLayer.Point
- All Superinterfaces:
CanvasLayer.Geometry
- Enclosing interface:
- CanvasLayer
A wrapper class encapsulating
Point on the canvas.-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classAn event that is fired after click on the point.static classAn event that is fired after modifying the point (as a result of drag and drop via UI).static classAn event that is fired after right click on the point. -
Method Summary
Modifier and TypeMethodDescriptionaddClickListener(Consumer<CanvasLayer.Point.ClickEvent> listener) Registers a new point click listener.Registers a new point modified (drag end) listener.Registers a new point right click listener.org.locationtech.jts.geom.PointReturns a JTS point.setEditable(boolean editable) Sets whether the geometry is to be modifiable on a canvas.setPopupContent(String popupContent) Adds a popup window to be opened as user clicks on the point.setPopupOptions(PopupWindowOptions options) Specifies options for a popup window added bysetPopupContent(String).setStyle(PointStyle style) Applies a style to the point.setTooltipContent(String tooltipContent) Adds a tooltip to be opened as user hovers on the point.setTooltipOptions(TooltipOptions options) Specifies options for a tooltip added bysetTooltipContent(String).Methods inherited from interface io.jmix.mapsui.component.CanvasLayer.Geometry
closePopup, closeTooltip, isEditable, openPopup, openTooltip
-
Method Details
-
getGeometry
org.locationtech.jts.geom.Point getGeometry()Returns a JTS point.- Specified by:
getGeometryin interfaceCanvasLayer.Geometry
-
setStyle
Applies a style to the point.- Parameters:
style- point style- Returns:
- current point. Useful for a fluent API.
-
setPopupContent
Adds a popup window to be opened as user clicks on the point.- Parameters:
popupContent- content of the popup window- Returns:
- current point. Useful for a fluent API.
-
setPopupOptions
Specifies options for a popup window added bysetPopupContent(String).- Parameters:
options- popup window options- Returns:
- current point. Useful for a fluent API.
-
setTooltipContent
Adds a tooltip to be opened as user hovers on the point.- Parameters:
tooltipContent- content of the tooltip box- Returns:
- current point. Useful for a fluent API.
-
setTooltipOptions
Specifies options for a tooltip added bysetTooltipContent(String).- Parameters:
options- tooltip options- Returns:
- current point. Useful for a fluent API.
-
setEditable
Description copied from interface:CanvasLayer.GeometrySets whether the geometry is to be modifiable on a canvas.- Specified by:
setEditablein interfaceCanvasLayer.Geometry
-
addClickListener
Registers a new point click listener.- Parameters:
listener- the listener to be added- Returns:
- a registration object for removing an event listener added to a source
-
addRightClickListener
Registers a new point right click listener.- Parameters:
listener- the listener to be added- Returns:
- a registration object for removing an event listener added to a source
-
addModifiedListener
Registers a new point modified (drag end) listener.- Parameters:
listener- the listener to be added- Returns:
- a registration object for removing an event listener added to a source
-