Package 

Interface LayoutController

  • All Implemented Interfaces:
    
public interface LayoutController

    Controls layout behavior on the map view.

    Access from the map view controller registry after the view is ready.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Unit setVerticalOffset(Double offset) Set the layout's vertical offset
      abstract Unit setHorizontalOffset(Double offset) Set the layout's horizontal offset
      abstract Unit setOffsets(Double horizontalOffset, Double verticalOffset) Set the layout's offsets
      abstract Long addObstructedRegion(Integer x, Integer y, Integer width, Integer height) Create a new obstructed region
      abstract Long addObstructedRegion(Rect rect) Create a new obstructed region
      abstract Boolean removeObstructedRegion(Long id) Remove a specific obstructed region
      abstract Boolean removeAllObstructedRegions() Remove all obstructed regions
      abstract Unit setMapScaleBarMargin(Double horizontalMargin, Double verticalMargin) set Scale bar margin please noted that the start point of the scale bar is the bottom right corner, and all the margins are based on the start point
      abstract Unit setCopyrightMargin(Double horizontalMargin, Double verticalMargin) Sets the copyright margin for the map view.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • setVerticalOffset

         abstract Unit setVerticalOffset(Double offset)

        Set the layout's vertical offset

        Parameters:
        offset - the offset value

      • setHorizontalOffset

         abstract Unit setHorizontalOffset(Double offset)

        Set the layout's horizontal offset

        Parameters:
        offset - the offset value

      • setOffsets

         abstract Unit setOffsets(Double horizontalOffset, Double verticalOffset)

        Set the layout's offsets

        Parameters:
        horizontalOffset - the horizontal offset value
        verticalOffset - the vertical offset value

      • addObstructedRegion

         abstract Long addObstructedRegion(Integer x, Integer y, Integer width, Integer height)

        Create a new obstructed region

        Parameters:
        x - horizontal position of the obstructed region
        y - vertical position of the obstructed region
        width - width of the obstructed region
        height - height of the obstructed region

      • addObstructedRegion

         abstract Long addObstructedRegion(Rect rect)

        Create a new obstructed region

        Parameters:
        rect - Rect object which defines the obstructed region

      • removeObstructedRegion

         abstract Boolean removeObstructedRegion(Long id)

        Remove a specific obstructed region

        Parameters:
        id - the id of an already created obstructed region

      • setMapScaleBarMargin

         abstract Unit setMapScaleBarMargin(Double horizontalMargin, Double verticalMargin)

        set Scale bar margin please noted that the start point of the scale bar is the bottom right corner, and all the margins are based on the start point

        Parameters:
        horizontalMargin - horizontal margin
        verticalMargin - vertical margin

      • setCopyrightMargin

         abstract Unit setCopyrightMargin(Double horizontalMargin, Double verticalMargin)

        Sets the copyright margin for the map view.

        The copyright text is positioned relative to the bottom-left corner of the view. Both margin values specify the offset from this reference point, measured in pixels.

        Parameters:
        horizontalMargin - The horizontal margin offset from the left edge, in pixels
        verticalMargin - The vertical margin offset from the bottom edge, in pixels