@bespunky/angular-google-maps Official Docs
  1. Classes
  2. GoogleMapsMarker

Description

The angular-ready wrapper for the native google.maps.Marker class.

Extends

GoogleMapsDrawableOverlay

Implements

IGoogleMapsMarker

Index

overlays/modules/marker/google-maps-marker.ts

Properties
Methods

Constructor

constructor(map: IGoogleMap, api: GoogleMapsApiService, native: any)
Parameters:
Name Type Optional
map IGoogleMap No
api GoogleMapsApiService No
native any No
overlays/modules/marker/google-maps-marker.ts:24

Properties

Public map
Type: IGoogleMap
Inherited from GoogleMapsDrawableOverlay
The map to which this overlay should be added.
GoogleMapsDrawableOverlay:30
Public Readonly type
Type: OverlayType
Inherited from GoogleMapsDrawableOverlay
The type of overlay this wrapper holds. Used by the `OverlayTracker` to distinguish between types.
GoogleMapsDrawableOverlay:30
Public custom
Type: any
Inherited from GoogleMapsNativeObjectWrapper
GoogleMapsNativeObjectWrapper:16
Public Readonly native
Type: TNative
Inherited from GoogleMapsNativeObjectWrapper
The instantiated native object to be wrapped.
GoogleMapsNativeObjectWrapper:24

Methods

Public getBounds
getBounds()
Inherited from GoogleMapsDrawableOverlay
Returns: google.maps.LatLngBounds
GoogleMapsDrawableOverlay:31
Public getPosition
getPosition()
Returns: google.maps.LatLngLiteral
overlays/modules/marker/google-maps-marker.ts:36
Public setPosition
setPosition(position: BoundsLike)
Decorators :
@OutsideAngular()
Parameters:
Name Type Optional
position BoundsLike No
Returns: void
overlays/modules/marker/google-maps-marker.ts:42
Public attach
attach(map: IGoogleMap)
Inherited from GoogleMapsDrawableOverlay

Assigns the overlay to the specified map. If possible, prefer using the appropriate GoogleMap.createXXX() method instead. If not possible, it is the responsability of the caller to add the overlay to the OverlayTracker in the GoogleMap.overlays object. Otherwise, inconsistencies and unexpected behaviours might occur.

Parameters:
Name Type Optional Description
map IGoogleMap No

The map to dispaly the overlay on.
Returns: void
GoogleMapsDrawableOverlay:44
Public detach
detach()
Inherited from GoogleMapsDrawableOverlay

Removes the overlay from the map it is attached to. If possible, prefer using the GoogleMap.removeOverlay() method instead. If not possible, it is the responsability of the caller to remove the overlay from the OverlayTracker in the GoogleMap.overlays object. Otherwise, inconsistencies and unexpected behaviours might occur.

Returns: void
GoogleMapsDrawableOverlay:56
Public clearListeners
clearListeners()
Inherited from GoogleMapsNativeObjectEmittingWrapper

Unregisters all handlers of any previously registered native event.

Returns: void
GoogleMapsNativeObjectEmittingWrapper:73
Public listenTo
listenTo(eventName: string, handleEvent: (args: any[]) => void)
Inherited from GoogleMapsNativeObjectEmittingWrapper

Registers a handler to a specific event of the native object and takes care of executing the handler inside angular's zone.

Parameters:
Name Type Optional Description
eventName string No

The name of the native event to register the handler for.
handleEvent function No

The function to execute when the event is triggered by the native object.
Returns: void

An function for unregistering the handler from the event.
GoogleMapsNativeObjectEmittingWrapper:47
Public stopListeningTo
stopListeningTo(eventName: string)
Inherited from GoogleMapsNativeObjectEmittingWrapper

Unregisters all handlers previously registered to handle a specific event.

Parameters:
Name Type Optional Description
eventName string No

The name of the native event for which to unregister all handlers.
Returns: void
GoogleMapsNativeObjectEmittingWrapper:65
Public setCustom
setCustom(custom: any)
Inherited from GoogleMapsNativeObjectWrapper
Parameters:
Name Type Optional
custom any No
Returns: void
GoogleMapsNativeObjectWrapper:31 
import { GoogleMapsApiService, NativeObjectWrapper, IGoogleMap, OutsideAngular, BoundsLike, Delegation } from '@bespunky/angular-google-maps/core';
import { GoogleMapsDrawableOverlay                 } from '../../abstraction/base/google-maps-drawable-overlay';
import { OverlayType                               } from '../../abstraction/base/overlay-type.enum';
import { IGoogleMapsMarker, WrappedMarkerFunctions } from './i-google-maps-marker';

/** Extends intellisense for `GoogleMapsMarker` with native marker functions. */
export interface GoogleMapsMarker extends WrappedMarkerFunctions { }

/**
 * The angular-ready wrapper for the native `google.maps.Marker` class.
 *
 * @export
 * @class GoogleMapsMarker
 * @extends {GoogleMapsDrawableOverlay<google.maps.Marker>}
 * @implements {IGoogleMapsMarker}
 */
// @dynamic
@NativeObjectWrapper<GoogleMapsMarker>({
    getMap: Delegation.Exclude,
    setMap: Delegation.Exclude
})
export class GoogleMapsMarker extends GoogleMapsDrawableOverlay<google.maps.Marker> implements IGoogleMapsMarker
{
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    constructor(map: IGoogleMap, api: GoogleMapsApiService, native: any /* See super for docs on `any` */)
    {
        super(OverlayType.Marker, map, api, native);
    }
    
    public getBounds(): google.maps.LatLngBounds
    {
        return this.api.geometry.defineCoordBounds(this.getPosition());
    }

    public getPosition(): google.maps.LatLngLiteral
    {
        return this.api.geometry.toLiteralCoord(this.native.getPosition());
    }
    
    @OutsideAngular
    public setPosition(position: BoundsLike): void
    {
        this.native.setPosition(this.api.geometry.centerOf(position));
    }
}

results matching ""

    No results matching ""