On this page

Class ImageViewerMarker`Maptiler`

Hierarchy (View Summary)

Evented
- ImageViewerMarker

Constructors

`Maptiler`constructor

new ImageViewerMarker(__namedParameters: MarkerOptions): ImageViewerMarker
Parameters
- __namedParameters: MarkerOptions
Returns ImageViewerMarker
Overrides Evented.constructor

Methods

`Maptiler`addClassName

addClassName(className: string): ImageViewerMarker
Adds a class name to the ImageViewerMarker.
Parameters
- className: string
  The class name to add to the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

`Maptiler`addTo

addTo(viewer: ImageViewer): ImageViewerMarker
Adds the ImageViewerMarker to an instance of ImageViewer.
Parameters
- viewer: ImageViewer
  The instance of ImageViewer to add the ImageViewerMarker to.
Returns ImageViewerMarker
The ImageViewerMarker instance.

`Maptiler`fire

fire(
event: Event | "dragstart" | "drag" | "dragend",
data?: Record<string, any>,
): ImageViewerMarker
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.

Overrides Evented.fire

`Maptiler`getElement

getElement(): HTMLElement
Gets the element of the ImageViewerMarker.

Returns HTMLElement
The element of the ImageViewerMarker.

`Maptiler`getOffset

getOffset(): Point
Gets the offset of the ImageViewerMarker.

Returns Point
The offset of the ImageViewerMarker.

See
PointLike

`Maptiler`getPitchAlignment

getPitchAlignment(): Alignment
Gets the pitch alignment of the ImageViewerMarker.

Returns Alignment
The pitch alignment of the ImageViewerMarker.

See
MapLibreGL.Alignment

`Maptiler`getPopup

getPopup(): Popup
Gets the popup of the ImageViewerMarker.

Returns Popup
The popup of the ImageViewerMarker.

See
Popup

`Maptiler`getPosition

getPosition(): [number, number]
Gets the position of the ImageViewerMarker.

Returns [number, number]
The position of the ImageViewerMarker.

See
PointLike

`Maptiler`getRotation

getRotation(): number
Gets the rotation of the ImageViewerMarker.

Returns number
The rotation of the ImageViewerMarker.

`Maptiler`getRotationAlignment

getRotationAlignment(): Alignment
Gets the rotation alignment of the ImageViewerMarker.

Returns Alignment
The rotation alignment of the ImageViewerMarker.

See
MapLibreGL.Alignment

`Maptiler`isDraggable

isDraggable(): boolean
Checks if the ImageViewerMarker is draggable.

Returns boolean
True if the ImageViewerMarker is draggable, false otherwise.

`Maptiler`isWithinImageBounds

isWithinImageBounds(): boolean
Checks if the ImageViewerMarker is within the image bounds.

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

listens

listens(type: string): boolean
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

Inherited from Evented.listens

`Maptiler`off

off(
event: "dragstart" | "drag" | "dragend",
listener: (e: ImageViewerMarkerEvent) => void,
): ImageViewerMarker
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.

Overrides Evented.off

`Maptiler`on

on(
event: "dragstart" | "drag" | "dragend",
listener: (e: ImageViewerMarkerEvent) => void,
): Subscription
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.

Overrides Evented.on

once

once(type: string, listener?: Listener): Promise<any> | ImageViewerMarker
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

Inherited from Evented.once

`Maptiler`remove

remove(): ImageViewerMarker
Removes the ImageViewerMarker from the ImageViewer and cleans up the event listeners.

Returns ImageViewerMarker
The ImageViewerMarker instance.

`Maptiler`removeClassName

removeClassName(className: string): ImageViewerMarker
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.

`Maptiler`setDraggable

setDraggable(draggable: boolean): ImageViewerMarker
Sets the draggable state of the ImageViewerMarker.
Parameters
- draggable: boolean
  The draggable state of the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

setEventedParent

setEventedParent(parent?: Evented | null, data?: any): this
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
- Optionalparent: Evented | null
- Optionaldata: any
Returns this
Inherited from Evented.setEventedParent

`Maptiler`setOffset

setOffset(offset: PointLike): ImageViewerMarker
Sets the offset of the ImageViewerMarker.
Parameters
- offset: PointLike
  The offset of the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

`Maptiler`setOpacity

setOpacity(opacity?: string, opacityWhenCovered?: string): ImageViewerMarker
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.

`Maptiler`setPitchAlignment

setPitchAlignment(pitchAlignment: Alignment): ImageViewerMarker
Sets the pitch alignment of the ImageViewerMarker.
Parameters
- pitchAlignment: Alignment
  The pitch alignment of the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

See
MapLibreGL.Alignment

`Maptiler`setPopup

setPopup(popup: Popup): ImageViewerMarker
Sets the popup of the ImageViewerMarker.
Parameters
- popup: Popup
  The popup of the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

See
Popup

`Maptiler`setPosition

setPosition(px: [number, number]): ImageViewerMarker
Sets the position of the ImageViewerMarker.
Parameters
- px: [number, number]
  The position of the ImageViewerMarker in image pixels.
Returns ImageViewerMarker
The ImageViewerMarker instance.

`Maptiler`setRotation

setRotation(rotation: number): ImageViewerMarker
Sets the rotation of the ImageViewerMarker.
Parameters
- rotation: number
  The rotation of the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

`Maptiler`setRotationAlignment

setRotationAlignment(rotationAlignment: Alignment): ImageViewerMarker
Sets the rotation alignment of the ImageViewerMarker.
Parameters
- rotationAlignment: Alignment
  The rotation alignment of the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

See
MapLibreGL.Alignment

`Maptiler`setSubpixelPositioning

setSubpixelPositioning(subpixelPositioning: boolean): ImageViewerMarker
Sets if subpixel positioning is enabled for the ImageViewerMarker.
Parameters
- subpixelPositioning: boolean
  The subpixel positioning of the ImageViewerMarker.
Returns ImageViewerMarker
The ImageViewerMarker instance.

`Maptiler`toggleClassName

toggleClassName(className: string): ImageViewerMarker
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.

`Maptiler`togglePopup

togglePopup(): ImageViewerMarker
Toggles the popup of the ImageViewerMarker.

Returns ImageViewerMarker
The ImageViewerMarker instance.

Was this helpful?

Class ImageViewerMarkerMaptiler

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

Maptilerconstructor

Parameters

Returns ImageViewerMarker

Methods

MaptileraddClassName

Parameters

Returns ImageViewerMarker

MaptileraddTo

Parameters

Returns ImageViewerMarker

Maptilerfire

Parameters

Returns ImageViewerMarker

MaptilergetElement

Returns HTMLElement

MaptilergetOffset

Returns Point

See

MaptilergetPitchAlignment

Returns Alignment

See

MaptilergetPopup

Returns Popup

See

MaptilergetPosition

Returns [number, number]

See

MaptilergetRotation

Returns number

MaptilergetRotationAlignment

Returns Alignment

See

MaptilerisDraggable

Returns boolean

MaptilerisWithinImageBounds

Returns boolean

listens

Parameters

Returns boolean

Maptileroff

Parameters

Returns ImageViewerMarker

Maptileron

Parameters

Returns Subscription

once

Parameters

Returns Promise<any> | ImageViewerMarker

Maptilerremove

Returns ImageViewerMarker

MaptilerremoveClassName

Parameters

Returns ImageViewerMarker

MaptilersetDraggable

Parameters

Returns ImageViewerMarker

setEventedParent

Parameters

Returns this

MaptilersetOffset

Parameters

Returns ImageViewerMarker

MaptilersetOpacity

Parameters

Returns ImageViewerMarker

MaptilersetPitchAlignment

Parameters

Returns ImageViewerMarker

See

MaptilersetPopup

Parameters

Returns ImageViewerMarker

See

MaptilersetPosition

Class ImageViewerMarker`Maptiler`

`Maptiler`constructor

`Maptiler`addClassName

`Maptiler`addTo

`Maptiler`fire

`Maptiler`getElement

`Maptiler`getOffset

`Maptiler`getPitchAlignment

`Maptiler`getPopup

`Maptiler`getPosition

`Maptiler`getRotation

`Maptiler`getRotationAlignment

`Maptiler`isDraggable

`Maptiler`isWithinImageBounds

`Maptiler`off

`Maptiler`on

`Maptiler`remove

`Maptiler`removeClassName

`Maptiler`setDraggable

`Maptiler`setOffset

`Maptiler`setOpacity

`Maptiler`setPitchAlignment

`Maptiler`setPopup

`Maptiler`setPosition

`Maptiler`setRotation

`Maptiler`setRotationAlignment

`Maptiler`setSubpixelPositioning

`Maptiler`toggleClassName

`Maptiler`togglePopup