Package io.jmix.mapsflowui.kit.component.model.layer.option

Interface HasBaseVectorOptions

All Superinterfaces:
HasBaseLayerOptions
All Known Implementing Classes:
BaseVectorLayer, BaseVectorLayerOptions, NoOpVectorLayer, VectorLayer, VectorLayerOptions
public interface HasBaseVectorOptions extends HasBaseLayerOptions
Options for layer that renders vector data client-side.

For more details see: BaseVectorLayer docs

  • Method Details

    • getRenderBuffer

      Double getRenderBuffer()
      Returns:
      the render buffer in pixels, null value means that default value is used: 100

    • setRenderBuffer

      void setRenderBuffer(Double renderBuffer)
      Sets the buffer in pixels around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection. The hit detection only checks features that are within a certain distance of the given position. For large icons, the actual geometry of a feature might be too far away and is not considered. Recommended value: the size of the largest symbol, line width or label.

      Note, render buffer is set only at creation time and cannot be changed at runtime.

      For more details see: BaseVectorLayer docs

      Parameters:
      renderBuffer -

    • isDeclutter

      Boolean isDeclutter()
      Returns:
      whether declutter images and texts, null value means that default value is used: false

    • setDeclutter

      void setDeclutter(Boolean declutter)
      Sets whether declutter images and texts. Decluttering is applied to all image and text styles of all vector layers that have set this to true. The priority is defined by the z-index of the layer, the Style.withZIndex(Integer) of the style and the render order of features. Higher z-index means higher priority. Within the same z-index, a feature rendered before another has higher priority.

      As an optimization decluttered features from layers with the same HasBaseLayerOptions.setClassName(String) are rendered above the Fill and Stroke styles of all of those layers regardless of z-index. To opt out of this behavior and place declutterd features with their own layer configure the layer with a className other than 'ol-layer'.

      The default value is false.

      Note, declutter is set only at creation time and cannot be changed at runtime.

      For more details see: BaseVectorLayer docs

      Parameters:
      declutter - whether declutter images and texts

    • getBackground

      String getBackground()
      Returns:
      background color for the layer or null if not set

    • setBackground

      void setBackground(String color)
      Sets the background color for the layer. If not specified, no background will be rendered.

      Note, background color is set only at creation time and cannot be changed at runtime.

      For more details see: BaseVectorLayer docs

      Parameters:
      color - color to set

    • isUpdateWhileAnimating

      Boolean isUpdateWhileAnimating()
      Returns:
      whether feature batches will be recreated during animations, null value means that default value is used: false

    • setUpdateWhileAnimating

      void setUpdateWhileAnimating(Boolean updateWhileAnimating)
      Sets whether feature batches will be recreated during animations. This means that no vectors will be shown clipped, but the setting will have a performance impact for large amounts of vector data. When set to false, batches will be recreated when no animation is active.

      The default value is false.

      Note, "updateWhileAnimating" is set only at creation time and cannot be changed at runtime. For more details see: BaseVectorLayer docs

      Parameters:
      updateWhileAnimating - whether feature batches will be recreated during animations

    • getUpdateWhileInteracting

      Boolean getUpdateWhileInteracting()
      Returns:
      whether feature batches will be recreated during interactions, null value means that default value is used: false

    • setUpdateWhileInteracting

      void setUpdateWhileInteracting(Boolean updateWhileInteracting)
      Sets whether feature batches will be recreated during interactions. The default value is false.

      For instance, if the user moves map by mouse, the features that were not visible will be drawn after the user releases the pressed mouse. To enable always drawing features, set property to true.

      Note, "updateWhileInteracting" is set only at creation time and cannot be changed at runtime.

      For more details see: BaseVectorLayer docs

      Parameters:
      updateWhileInteracting - whether feature batches will be recreated during interactions