Maps

The Maps components enables developers to display specific locations, such as points of interest, businesses, or user-defined addresses, on a map interface.

About the component


Image Description
  •  Last Update 25 Oct, 2023
  •  Component Version : 2.0.0
  •  API 21, Android 5.0 Lollipop
  •  29 Blocks Available

Circle

A circle drawn on the map. Can be set to respond to touch events, and can be set to have a tooltip appear when tapped.

Overview

A circle drawn on the map.

Events

Image Description
Events

Click

  • Indicates that the user tapped on the Circle.

    • Image Description
    Events

    Drag

  • Indicates that the user dragged the Circle.

    • Image Description
    Events

    LongClick

  • Indicates that the user long-pressed on the Circle.

    • Image Description
    Events

    StartDrag

  • Indicates that the user has started a drag operation on the Circle.

    • Image Description
    Events

    StopDrag

  • Indicates that the user has stopped a drag operation on the Circle.

    • Methods

    Image Description
    Methods

    DistanceToFeature

  • Computes the distance between the Circle and the given map feature.

    • # Name Type(s) Default Value
    1 mapFeature map feature
    2 centroids boolean
    Image Description
    Methods

    DistanceToPoint

  • Compute the distance, in meters, between a circle and a point.

    • # Name Type(s) Default Value
    1 latitude double
    2 longitude double
    3 centroid boolean
    Image Description
    Methods

    HideInfobox

  • Hide the infobox if it is shown.

    • Image Description
    Methods

    SetLocation

  • Moves the Circle to be centered at the given latitude and longitude.

    • # Name Type(s) Default Value
    1 latitude double
    2 longitude double
    Image Description
    Methods

    ShowInfobox

  • Show the infobox for the circle. This will override any infobox triggered by a user tap if infoboxes are enabled.

    • Properties

    Image Description
    Image Description
    Properties

    Description

  • Gets the description displayed in the info box. This will appear when the user taps on the Circle if {@link #EnableInfobox()} is set to true.

  • Specifies the text displayed in the info box. This will appear when the user taps on the Circle if {@link #EnableInfobox()} is set to true.

    • # Name Type(s) Default Value
    1 Description String
    2 Description String
    Image Description
    Image Description
    Properties

    Draggable

  • Gets whether the Circle is draggable by the user.

  • Specifies whether the Circle should be draggable by the user.

    • # Name Type(s) Default Value
    1 Draggable boolean
    2 Draggable boolean false
    Image Description
    Image Description
    Properties

    EnableInfobox

  • Returns whether or not the infobox is enabled for the Circle.

  • Enables or disables the infobox for the Circle. The infobox will be displayed when the user taps on the Circle. The content of the infobox is set using the {@link #Description(String)} and {@link #Title(String)} properties.

    • # Name Type(s) Default Value
    1 EnableInfobox boolean
    2 EnableInfobox boolean false
    Image Description
    Image Description
    Properties

    FillColor

  • Gets the fill color of the Circle, as an alpha-red-green-blue integer.

  • Specifies the fill color of the Circle, as an alpha-red-green-blue integer.

    • # Name Type(s) Default Value
    1 FillColor int
    2 FillColor int
    Image Description
    Image Description
    Properties

    FillOpacity

  • Gets the opacity of the color used to fill the Circle.

  • Specifies the opacity of the color used to fill the Circle. A value of 0.0 will result in a totally transparent fill while 1.0 will result in a totally opaque fill.

    • # Name Type(s) Default Value
    1 FillOpacity float
    2 FillOpacity float 0.5
    Image Description
    Image Description
    Properties

    Latitude

  • Gets the latitude of the center of the circle

  • Specifies the latitude of the center of the circle.

    • # Name Type(s) Default Value
    1 Latitude double
    2 Latitude double 0.0
    Image Description
    Image Description
    Properties

    Longitude

  • Gets the longitude of the center of the circle.

  • Specifies the longitude of the center of the circle.

    • # Name Type(s) Default Value
    1 Longitude double
    2 Longitude double 0.0
    Image Description
    Image Description
    Properties

    Radius

  • Gets the radius of the circle, in meters.


  • Specifies the radius of the circle, in meters.

    • # Name Type(s) Default Value
    1 Radius double
    2 Radius double 0.0
    Image Description
    Image Description
    Properties

    StrokeColor

  • Gets the color of the stroke (outline) of the Circle, as an alpha-red-green-blue integer.

  • Specifies the color of the stroke (outline) of the Circle, as an alpha-red-green-blue integer.

    • # Name Type(s) Default Value
    1 StrokeColor int
    2 StrokeColor int
    Image Description
    Image Description
    Properties

    StrokeOpacity

  • Gets the opacity of the stroke (outline) of the Circle.

  • Specifies the opacity of the stroke (outline) of the Circle. A value of 0.0 will result in a totally transparent stroke while 1.0 will result in a totally opaque stroke.

    • # Name Type(s) Default Value
    1 StrokeOpacity float
    2 StrokeOpacity float 1.0
    Image Description
    Image Description
    Properties

    StrokeWidth

  • Gets the width of the stroke (outline) of the Circle, in pixels.

  • Specifies the width of the stroke (outline) of the Circle, in pixels.

    • # Name Type(s) Default Value
    1 StrokeWidth int
    2 StrokeWidth int 1
    Image Description
    Image Description
    Properties

    Title

  • Gets the title displayed in the info box that appears when the user taps on the Circle.

  • Specifies the title displayed in the info box that appears when the user taps on the Circle.

    • # Name Type(s) Default Value
    1 Title String
    2 Title String ""
    Image Description
    Properties

    Type

  • Returns the type of the feature.


    • # Name Type(s) Default Value
    1 Type String
    Image Description
    Image Description
    Properties

    Visible

  • Gets the current visibility of the Circle.


  • Specifies the visibility of this Circle. If a Circle is not visible, it will not respond to user input, but it will continue to be present in the Map's {@link #Features()} property.

    • # Name Type(s) Default Value
    1 Visible boolean
    2 Visible boolean true