Class MapCaptionAPI

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

Export

Hierarchy

Constructors

Properties

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

Memberof

APIScope

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

Type declaration

    • (p): Promise<string>
    • Parameters

      Returns Promise<string>

Accessors

  • get $element(): App<Element>
  • Returns App<Element>

  • get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>
  • The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

    Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

    Memberof

    APIScope

Methods

  • Configure the map caption using the given config

    Parameters

    Returns void

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

    Parameters

    • p: Point

      the cursor map point

    Returns Promise<string>

    the formatted string using given cursor map coordinates

    Function

    formatBasemap

  • Formats a lambert point string using mouse map point coordinates

    Parameters

    • p: Point

      the cursor map point

    Returns Promise<string>

    the formatted string using given cursor map coordinates

    Function

    formatLambert

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

    Parameters

    • p: Point

      the cursor map point

    Returns Promise<string>

    the formatted string using given cursor map coordinates

    Function

    formatLatLongDD

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

    Parameters

    • p: Point

      the cursor map point

    Returns Promise<string>

    the formatted string using given cursor map coordinates

    Function

    formatLatLongDDM

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

    Parameters

    • p: Point

      the cursor map point

    Returns Promise<string>

    the formatted string using given cursor map coordinates

    Function

    formatLatLongDMSString

  • Formats a mercator point string using mouse map point coordinates

    Parameters

    • p: Point

      the cursor map point

    Returns Promise<string>

    the formatted string using given cursor map coordinates

    Function

    formatMercator

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

    Parameters

    • p: undefined | Point

      the cursor map point

    Returns Promise<string>

    the formatted string of the map point

  • Formats a UTM string using mouse map point coordinates

    Parameters

    • p: Point

      the cursor map point

    Returns Promise<string>

    the formatted string using given cursor map coordinates

    Function

    formatUTM

  • 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

    Parameters

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

    Returns void

    Function

    setPointFormatter

  • 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

    Parameters

    • newAttribution: undefined | Attribution

      incoming new attribution

    Returns void

    Function

    updateAttribution

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

    Returns void

    Function

    updateScale

  • Private

    Wraps value between the minimum and maximum value If value is between bounds, it will be returned as it is

    Parameters

    • val: number

      value to be wrapped

    • min: number

      minimum value

    • max: number

      maximum value

    Returns number

    the wrapped value

    Function

    wrapValue

Generated using TypeDoc