Join us online - 19th of November
Save your spot

Class ImageViewerMarkerMaptiler

Hierarchy (View Summary)

Index
constructor
addClassName addTo fire getElement getOffset getPitchAlignment getPopup getPosition getRotation getRotationAlignment isDraggable isWithinImageBounds listens off on once remove removeClassName setDraggable setEventedParent setOffset setOpacity setPitchAlignment setPopup setPosition setRotation setRotationAlignment setSubpixelPositioning toggleClassName togglePopup

  • Adds a class name to the ImageViewerMarker.

    Parameters

    • className: string

      The class name to add to the ImageViewerMarker.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Fires an event on the ImageViewerMarker.

    Parameters

    • event: Event | "dragstart" | "drag" | "dragend"

      The event to fire.

    • Optionaldata: Record<string, any>

      The data to fire the event with.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Gets the element of the ImageViewerMarker.

    Returns HTMLElement

    The element of the ImageViewerMarker.

  • Gets the offset of the ImageViewerMarker.

    Returns Point

    The offset of the ImageViewerMarker.

    PointLike

  • Gets the popup of the ImageViewerMarker.

    Returns Popup

    The popup of the ImageViewerMarker.

    Popup

  • Gets the position of the ImageViewerMarker.

    Returns [number, number]

    The position of the ImageViewerMarker.

    PointLike

  • Gets the rotation of the ImageViewerMarker.

    Returns number

    The rotation of the ImageViewerMarker.

  • Checks if the ImageViewerMarker is draggable.

    Returns boolean

    True if the ImageViewerMarker is draggable, false otherwise.

  • Checks if the ImageViewerMarker is within the image bounds.

    Returns boolean

    True if the ImageViewerMarker is within the image bounds, false otherwise.

  • Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

    Parameters

    • type: string

      The event type

    Returns boolean

    true if there is at least one registered listener for specified event type, false otherwise

  • Removes an event listener from the ImageViewerMarker.

    Parameters

    • event: "dragstart" | "drag" | "dragend"

      The event to remove the listener from.

    • listener: (e: ImageViewerMarkerEvent) => void

      The listener to remove.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Adds an event listener to the ImageViewerMarker.

    Parameters

    • event: "dragstart" | "drag" | "dragend"

      The event to add the listener to.

    • listener: (e: ImageViewerMarkerEvent) => void

      The listener to add.

    Returns Subscription

    The ImageViewerMarker instance.

  • Adds a listener that will be called only once to a specified event type.

    The listener will be called first time the event fires after the listener is registered.

    Parameters

    • type: string

      The event type to listen for.

    • Optionallistener: Listener

      The function to be called when the event is fired the first time.

    Returns Promise<any> | ImageViewerMarker

    this or a promise if a listener is not provided

  • Removes the ImageViewerMarker from the ImageViewer and cleans up the event listeners.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Removes a class name from the ImageViewerMarker dom element.

    Parameters

    • className: string

      The class name to remove from the ImageViewerMarker.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Sets the draggable state of the ImageViewerMarker.

    Parameters

    • draggable: boolean

      The draggable state of the ImageViewerMarker.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Bubble all events fired by this instance of Evented to this parent instance of Evented.

    Parameters

    • Optionalparent: Evented | null
    • Optionaldata: any

    Returns this

  • Sets the opacity of the ImageViewerMarker.

    Parameters

    • Optionalopacity: string

      The opacity of the ImageViewerMarker.

    • OptionalopacityWhenCovered: string

      The opacity of the ImageViewerMarker when covered.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Sets the position of the ImageViewerMarker.

    Parameters

    • px: [number, number]

      The position of the ImageViewerMarker in image pixels.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Sets the rotation of the ImageViewerMarker.

    Parameters

    • rotation: number

      The rotation of the ImageViewerMarker.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Sets if subpixel positioning is enabled for the ImageViewerMarker.

    Parameters

    • subpixelPositioning: boolean

      The subpixel positioning of the ImageViewerMarker.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

  • Toggles a class name on the ImageViewerMarker dom element.

    Parameters

    • className: string

      The class name to toggle on the ImageViewerMarker.

    Returns ImageViewerMarker

    The ImageViewerMarker instance.

Was this helpful?