RAMP4 - v4.21.0
    Preparing search index...

    Class MapCaptionAPI

    A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

    APIScope

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    The instance of RampMap API scoped to a single Vue R4MP application.

    APIScope

    DEFAULT_POINT_FORMATTERS: any = ...
    pointFormatter: (p: Point) => Promise<string>

    Accessors

    • get $element(): App<Element>

      Returns App<Element>

    • get $vApp(): ComponentPublicInstance

      The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

      Returns ComponentPublicInstance

      APIScope

    Methods

    • Function

      Formats a string based on the current basemap projection using mouse map point coordinates

      formatBasemap

      Parameters

      • p: Point

        the cursor map point

      Returns Promise<string>

      the formatted string using given cursor map coordinates

    • Function

      Formats a lambert point string using mouse map point coordinates

      formatLambert

      Parameters

      • p: Point

        the cursor map point

      Returns Promise<string>

      the formatted string using given cursor map coordinates

    • Function

      Formats a lat/long DD string using mouse map point coordinates

      formatLatLongDD

      Parameters

      • p: Point

        the cursor map point

      Returns Promise<string>

      the formatted string using given cursor map coordinates

    • Function

      Formats a lat/long DDM string using mouse map point coordinates

      formatLatLongDDM

      Parameters

      • p: Point

        the cursor map point

      Returns Promise<string>

      the formatted string using given cursor map coordinates

    • Function

      Formats a lat/long DMS string using mouse map point coordinates

      formatLatLongDMSString

      Parameters

      • p: Point

        the cursor map point

      Returns Promise<string>

      the formatted string using given cursor map coordinates

    • Function

      Formats a mercator point string using mouse map point coordinates

      formatMercator

      Parameters

      • p: Point

        the cursor map point

      Returns Promise<string>

      the formatted string using given cursor map coordinates

    • Formats the map point using the selected formatting function Returns empty string if point is undefined

      Parameters

      • p: Point | undefined

        the cursor map point

      Returns Promise<string>

      the formatted string of the map point

    • Function

      Formats a UTM string using mouse map point coordinates

      formatUTM

      Parameters

      • p: Point

        the cursor map point

      Returns Promise<string>

      the formatted string using given cursor map coordinates

    • Function

      Sets the current point formatter Will accept the string id of a default formatter, or a new formatter with the correct formatter signature

      If given string id is not valid, then the point formatter is not changed

      setPointFormatter

      Parameters

      • value: string | ((p: Point) => Promise<string>)

      Returns void

    • Function

      Updates the attribution on the map-caption bar Applies default ESRI attribution if incoming attribution is disabled or has undefined elements

      Updates map-caption store to notify map-caption component observer

      updateAttribution

      Parameters

      • newAttribution: Attribution | undefined

        incoming new attribution

      Returns void

    • Function

      Calculates a scale bar for the current resolution Updates map-caption store to notify map-caption component observer

      updateScale

      Returns void