Click or drag to resize

Telogis.GeoBase.MapLayers.ZoomIndicator

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
MapLayers.ZoomIndicator Class

MapLayers.ZoomIndicator inherits from MapLayers.ImageObject.

A map object used to briefly display a zooming image at the focal point of a map's zoom, making it clear how the map is being centered.

Constructor
NameDescription
MapLayers.ZoomIndicator(config)

Arguments

  • config (Object) - Configuration options for the zoom-indicator.

    Properties
    NameTypeDescription
    durationNumber

    The total time, in milliseconds, that the zoom-indicator animation should take.

    Defaults to 400.
    fadeBoolean

    Whether the opacity of the zoom-indicator should be decreased as its animation progresses.

    Defaults to true.
    maxScaleNumber

    The maximum size that the zoom-indicator should be shown at, as a proportion of its base size.

    Defaults to 1.0.
    minScaleNumber

    The minimum size that the zoom-indicator should be shown at, as a proportion of its base size.

    Defaults to 0.5.
    srcString

    The URI of the image to use for the zoom-indicator's scaling animation. If this is specified, it overrides both MapLayers.ZoomIndicator.config.srcIn and MapLayers.ZoomIndicator.config.srcOut.

    Defaults to ''.
    srcInString

    The URI of the image to use for the zoom-indicator's scaling animation when the map is being zoomed inwards (magnification is increasing). If this is not supplied, the value specified by MapLayers.ZoomIndicator.config.srcOut is used instead.

    Defaults to ''.
    srcOutString

    The URI of the image to use for the zoom-indicator's scaling animation when the map is being zoomed outwards (magnification is decreasing). If this is not supplied, the value specified by MapLayers.ZoomIndicator.config.srcIn is used instead.

    Defaults to ''.
    stepCountNumber

    The number of steps to perform the zoom-indicator's scaling animation in. The time taken for each step will be an equal proportion of the indicator's duration setting.

    Defaults to 8.
Functions
NameDescription
animate (Boolean zoomingIn)

Animates the MapLayers.ZoomIndicator by scaling its image, illustrating how the map is being zoomed.

Arguments

  • zoomingIn (Boolean) - A value indicating the direction that the map is being zoomed in -- should be true if the magnification of the map is increasing; false otherwise.

setSize (Size size)

Sets the base size of the MapLayers.ZoomIndicator, which the maximum and minimum scale settings pertain to.

Arguments

  • size (Size) - The new base size for the zoom-indicator, in pixels.