Class MaptipAPI

constructor

• new MaptipAPI(iApi): MaptipAPI

• Parameters

  • iApi: InstanceAPI

    the RAMP instance

  Returns MaptipAPI

maptipStore

checkAtCoord

• checkAtCoord(screenPoint): Promise<void>

• Checks for a graphic at the given screen coordinates. On a graphic hit the point is put in the maptip store and the map/graphichit event is fired.

  Parameters

  • screenPoint: ScreenPoint

    The screen coordinates for the hitTest

  Returns Promise<void>

  resolves after the event is fired or no new graphic is hit.

clear

• clear(): void

• Clears the maptip from the map

  Returns void

generateDefaultMaptip

• generateDefaultMaptip(info): void

• Generates and sets the "default" maptip.

  Parameters

  • info: {
        attributes: Attributes;
        graphicHit: GraphicHitResult;
        icon: string;
        layer: LayerInstance;
        screenPoint: Point;
    }

    the tooltip info payload

    • attributes: Attributes

    • graphicHit: GraphicHitResult

    • icon: string

    • layer: LayerInstance

    • screenPoint: Point

  Returns void

getInstance

• getInstance(): any

• Get the tippy maptip instance Documentation: https://kabbouchi.github.io/tippyjs-v4-docs/tippy-instance/

  Returns any

  the tippy tooltip instance

getPoint

• getPoint(): undefined | MaptipProperties

• Get the current point for the maptip

  Returns undefined | MaptipProperties

  the current maptip map point

setContent

• setContent(content): void

• Set the html string for the maptip If empty string is provided, the maptip will use the default content

  Parameters

  • content: string

    the new maptip html content

  Returns void

setPoint

• setPoint(maptipPoint): void

• Set the current maptip point. Undefined = maptip wont be shown.

  Parameters

  • maptipPoint: Point

  Returns void