@agm/core

constructor

constructor(_manager: LayerManager);

property visible

visible: boolean;

• Hide/show bicycling layer

method ngOnInit

ngOnInit: () => void;

constructor

constructor(_manager: CircleManager);

property centerChange

centerChange: EventEmitter<google.maps.LatLngLiteral>;

• This event is fired when the circle's center is changed.

property circleClick

circleClick: EventEmitter<google.maps.MouseEvent>;

• This event emitter gets emitted when the user clicks on the circle.

property circleDblClick

circleDblClick: EventEmitter<google.maps.MouseEvent>;

• This event emitter gets emitted when the user clicks on the circle.

property clickable

clickable: boolean;

• Indicates whether this Circle handles mouse events. Defaults to true.

property drag

drag: EventEmitter<google.maps.MouseEvent>;

• This event is repeatedly fired while the user drags the circle.

property dragEnd

dragEnd: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the user stops dragging the circle.

property draggable

draggable: boolean;

• If set to true, the user can drag this circle over the map. Defaults to false.

property dragStart

dragStart: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the user starts dragging the circle.

property editable

editable: boolean;

• If set to true, the user can edit this circle by dragging the control points shown at the center and around the circumference of the circle. Defaults to false.

property fillColor

fillColor: string;

• The fill color. All CSS3 colors are supported except for extended named colors.

property fillOpacity

fillOpacity: number;

• The fill opacity between 0.0 and 1.0.

property latitude

latitude: number;

• The latitude position of the circle (required).

property longitude

longitude: number;

• The clickable position of the circle (required).

property mouseDown

mouseDown: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the DOM mousedown event is fired on the circle.

property mouseMove

mouseMove: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the DOM mousemove event is fired on the circle.

property mouseOut

mouseOut: EventEmitter<google.maps.MouseEvent>;

• This event is fired on circle mouseout.

property mouseOver

mouseOver: EventEmitter<google.maps.MouseEvent>;

• This event is fired on circle mouseover.

property mouseUp

mouseUp: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the DOM mouseup event is fired on the circle.

property radius

radius: number;

• The radius in meters on the Earth's surface.

property radiusChange

radiusChange: EventEmitter<number>;

• This event is fired when the circle's radius is changed.

property rightClick

rightClick: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the circle is right-clicked on.

property strokeColor

strokeColor: string;

• The stroke color. All CSS3 colors are supported except for extended named colors.

property strokeOpacity

strokeOpacity: number;

• The stroke opacity between 0.0 and 1.0

property strokePosition

strokePosition: string | number | symbol;

• The stroke position. Defaults to CENTER. This property is not supported on Internet Explorer 8 and earlier.

property strokeWeight

strokeWeight: number;

• The stroke width in pixels.

property visible

visible: boolean;

• Whether this circle is visible on the map. Defaults to true.

property zIndex

zIndex: number;

• The zIndex compared to other polys.

method getBounds

getBounds: () => Promise<google.maps.LatLngBounds>;

• Gets the LatLngBounds of this Circle.

method getCenter

getCenter: () => Promise<google.maps.LatLng>;

method forRoot

static forRoot: (
    lazyMapsAPILoaderConfig?: LazyMapsAPILoaderConfigLiteral
) => ModuleWithProviders<AgmCoreModule>;

• Please use this method when you register the module at the root level.

constructor

constructor(_manager: DataLayerManager);

property geoJson

geoJson: string | object;

• The geoJson to be displayed

property layerClick

layerClick: EventEmitter<google.maps.Data.MouseEvent>;

• This event is fired when a feature in the layer is clicked.

property style

style: (param: google.maps.Data.Feature) => google.maps.Data.StyleOptions;

• The layer's style function.

method ngOnInit

ngOnInit: () => void;

constructor

constructor(
    _fitBoundsAccessor: FitBoundsAccessor,
    _fitBoundsService: FitBoundsService
);

property agmFitBounds

agmFitBounds: boolean;

• If the value is true, the element gets added to the bounds of the map. Default: true.

method getOptions

getOptions: () => google.maps.MapOptions;

constructor

constructor(loader: MapsAPILoader);

property geocoder$

protected readonly geocoder$: Observable<google.maps.Geocoder>;

method geocode

geocode: (
    request: google.maps.GeocoderRequest
) => Observable<google.maps.GeocoderResult[]>;

constructor

constructor(_infoWindowManager: InfoWindowManager, _el: ElementRef);

property content

content: Node;

• Holds the native element that is used for the info window content.

property disableAutoPan

disableAutoPan: boolean;

• Disable auto-pan on open. By default, the info window will pan the map so that it is fully visible when it opens.

property hostMarker

hostMarker: AgmMarker;

• Holds the marker that is the host of the info window (if available)

property infoWindowClose

infoWindowClose: EventEmitter<void>;

• Emits an event when the info window is closed.

property isOpen

isOpen: boolean;

• Sets the open state for the InfoWindow. You can also call the open() and close() methods.

property latitude

latitude: number;

• The latitude position of the info window (only usefull if you use it ouside of a AgmMarker).

property longitude

longitude: number;

• The longitude position of the info window (only usefull if you use it ouside of a AgmMarker).

property maxWidth

maxWidth: number;

• Maximum width of the infowindow, regardless of content's width. This value is only considered if it is set before a call to open. To change the maximum width when changing content, call close, update maxWidth, and then open.

property zIndex

zIndex: number;

• All InfoWindows are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindows with lower values. By default, InfoWindows are displayed according to their latitude, with InfoWindows of lower latitudes appearing in front of InfoWindows at higher latitudes. InfoWindows are always displayed in front of markers.

method close

close: () => Promise<void>;

• Closes the info window.

method ngOnInit

ngOnInit: () => void;

method open

open: () => Promise<void>;

• Opens the info window.

constructor

constructor(_manager: KmlLayerManager);

property clickable

clickable: boolean;

• If true, the layer receives mouse events. Default value is true.

property defaultViewportChange

defaultViewportChange: EventEmitter<void>;

• This event is fired when the KML layers default viewport has changed.

property layerClick

layerClick: EventEmitter<google.maps.KmlMouseEvent>;

• This event is fired when a feature in the layer is clicked.

property preserveViewport

preserveViewport: boolean;

• By default, the input map is centered and zoomed to the bounding box of the contents of the layer. If this option is set to true, the viewport is left unchanged, unless the map's center and zoom were never set.

property screenOverlays

screenOverlays: boolean;

• Whether to render the screen overlays. Default true.

property statusChange

statusChange: EventEmitter<void>;

• This event is fired when the KML layer has finished loading. At this point it is safe to read the status property to determine if the layer loaded successfully.

property suppressInfoWindows

suppressInfoWindows: boolean;

• Suppress the rendering of info windows when layer features are clicked.

property url

url: string;

• The URL of the KML document to display.

property zIndex

zIndex: number;

• The z-index of the layer.

method ngOnChanges

ngOnChanges: (changes: SimpleChanges) => void;

method ngOnInit

ngOnInit: () => void;

constructor

constructor(
    _elem: ElementRef,
    _mapsWrapper: GoogleMapsAPIWrapper,
    _platformId: Object,
    _fitBoundsService: FitBoundsService,
    _zone: NgZone
);

property backgroundColor

backgroundColor: string;

• Color used for the background of the Map div. This color will be visible when tiles have not yet loaded as the user pans. This option can only be set when the map is initialized.

property boundsChange

boundsChange: EventEmitter<google.maps.LatLngBounds>;

• This event is fired when the viewport bounds have changed.

property centerChange

centerChange: EventEmitter<google.maps.LatLngLiteral>;

• This event emitter is fired when the map center changes.

property clickableIcons

clickableIcons: boolean;

• When false, map icons are not clickable. A map icon represents a point of interest, also known as a POI. By default map icons are clickable.

property controlSize

controlSize: number;

• The control size for the default map controls. Only governs the controls made by the Maps API itself

property disableDefaultUI

disableDefaultUI: boolean;

• Enables/disables all default UI of the Google map. Please note: When the map is created, this value cannot get updated.

property disableDoubleClickZoom

disableDoubleClickZoom: boolean;

• Enables/disables zoom and center on double click. Enabled by default.

property draggable

draggable: boolean;

• Enables/disables if map is draggable.

property draggableCursor

draggableCursor: string;

• The name or url of the cursor to display when mousing over a draggable map. This property uses the css * cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: [draggableCursor]="'url(http://www.example.com/icon.png), auto;'"

property draggingCursor

draggingCursor: string;

• The name or url of the cursor to display when the map is being dragged. This property uses the css cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: [draggingCursor]="'url(http://www.example.com/icon.png), auto;'"

property fitBounds

fitBounds: any;

• Sets the viewport to contain the given bounds. If this option to true, the bounds get automatically computed from all elements that use the AgmFitBounds directive.

property fitBoundsPadding

fitBoundsPadding: any;

• Padding amount for the bounds.

property gestureHandling

gestureHandling: google.maps.GestureHandlingOptions;

• This setting controls how gestures on the map are handled. Allowed values: - 'cooperative' (Two-finger touch gestures pan and zoom the map. One-finger touch gestures are not handled by the map.) - 'greedy' (All touch gestures pan or zoom the map.) - 'none' (The map cannot be panned or zoomed by user gestures.) - 'auto' [default] (Gesture handling is either cooperative or greedy, depending on whether the page is scrollable or not.

property idle

idle: EventEmitter<void>;

• This event is fired when the map becomes idle after panning or zooming.

property keyboardShortcuts

keyboardShortcuts: boolean;

• If false, prevents the map from being controlled by the keyboard. Keyboard shortcuts are enabled by default.

property latitude

latitude: number;

• The latitude that defines the center of the map.

property longitude

longitude: number;

• The longitude that defines the center of the map.

property mapClick

mapClick: EventEmitter<any>;

• This event emitter gets emitted when the user clicks on the map (but not when they click on a marker or infoWindow).

property mapControls

mapControls: QueryList<AgmMapControl>;

property mapDblClick

mapDblClick: EventEmitter<google.maps.MouseEvent>;

• This event emitter gets emitted when the user double-clicks on the map (but not when they click on a marker or infoWindow).

property mapReady

mapReady: EventEmitter<any>;

• This event is fired when the google map is fully initialized. You get the google.maps.Map instance as a result of this EventEmitter.

property mapRightClick

mapRightClick: EventEmitter<google.maps.MouseEvent>;

• This event emitter gets emitted when the user right-clicks on the map (but not when they click on a marker or infoWindow).

property mapTypeId

mapTypeId: string | number | symbol;

• The map mapTypeId. Defaults to 'roadmap'.

property mapTypeIdChange

mapTypeIdChange: EventEmitter<google.maps.MapTypeId>;

• This event is fired when the mapTypeId property changes.

property maxZoom

maxZoom: number;

• The maximal zoom level of the map allowed. When not provided, no restrictions to the zoom level are enforced.

property minZoom

minZoom: number;

• The minimal zoom level of the map allowed. When not provided, no restrictions to the zoom level are enforced.

property restriction

restriction: google.maps.MapRestriction;

• Options for restricting the bounds of the map. User cannot pan or zoom away from restricted area.

property scrollwheel

scrollwheel: boolean;

• If false, disables scrollwheel zooming on the map. The scrollwheel is enabled by default.

property showDefaultInfoWindow

showDefaultInfoWindow: boolean;

• A map icon represents a point of interest, also known as a POI. When map icons are clickable by default, an info window is displayed. When this property is set to false, the info window will not be shown but the click event will still fire

property styles

styles: google.maps.MapTypeStyle[];

• Styles to apply to each of the default map types. Note that for Satellite/Hybrid and Terrain modes, these styles will only apply to labels and geometry.

property tilesLoaded

tilesLoaded: EventEmitter<void>;

• This event is fired when the visible tiles have finished loading.

property tilt

tilt: number;

• Controls the automatic switching behavior for the angle of incidence of the map. The only allowed values are 0 and 45. The value 0 causes the map to always use a 0° overhead view regardless of the zoom level and viewport. The value 45 causes the tilt angle to automatically switch to 45 whenever 45° imagery is available for the current zoom level and viewport, and switch back to 0 whenever 45° imagery is not available (this is the default behavior). 45° imagery is only available for satellite and hybrid map types, within some locations, and at some zoom levels. Note: getTilt returns the current tilt angle, not the value specified by this option. Because getTilt and this option refer to different things, do not bind() the tilt property; doing so may yield unpredictable effects. (Default of AGM is 0 (disabled). Enable it with value 45.)

property usePanning

usePanning: boolean;

• When true and the latitude and/or longitude values changes, the Google Maps panTo method is used to center the map. See: https://developers.google.com/maps/documentation/javascript/reference#Map

property zoom

zoom: number;

• The zoom level of the map. The default zoom level is 8.

property zoomChange

zoomChange: EventEmitter<number>;

• This event is fired when the zoom level has changed.

method ngOnChanges

ngOnChanges: (changes: SimpleChanges) => void;

method triggerResize

triggerResize: (recenter?: boolean) => Promise<void>;

• Triggers a resize event on the google map instance. When recenter is true, the of the google map gets called with the current lat/lng values or fitBounds value to recenter the map. Returns a promise that gets resolved after the event was triggered.

property mapTypeIds

mapTypeIds: (string | number | symbol)[];

property style

style: string | number | symbol;

method getOptions

getOptions: () => google.maps.MapOptions;

constructor

constructor(_markerManager: MarkerManager);

property animation

animation: string | number | symbol;

• Which animation to play when marker is added to a map. This can be 'BOUNCE' or 'DROP'

property animationChange

animationChange: EventEmitter<'BOUNCE' | 'DROP'>;

• This event is fired when the marker's animation property changes.

property clickable

clickable: boolean;

• If true, the marker can be clicked. Default value is true.

property drag

drag: EventEmitter<google.maps.MouseEvent>;

• This event is repeatedly fired while the user drags the marker.

property dragEnd

dragEnd: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the user stops dragging the marker.

property draggable

draggable: boolean;

• If true, the marker can be dragged. Default value is false.

property dragStart

dragStart: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the user starts dragging the marker.

property iconUrl

iconUrl: any;

• Icon (the URL of the image) for the foreground.

property label

label: any;

• The label (a single uppercase character) for the marker.

property latitude

latitude: number;

• The latitude position of the marker.

property longitude

longitude: number;

• The longitude position of the marker.

property markerClick

markerClick: EventEmitter<AgmMarker>;

• This event emitter gets emitted when the user clicks on the marker.

property markerDblClick

markerDblClick: EventEmitter<AgmMarker>;

• This event emitter gets emitted when the user clicks twice on the marker.

property markerRightClick

markerRightClick: EventEmitter<void>;

• This event is fired when the user rightclicks on the marker.

property mouseOut

mouseOut: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the user mouses outside the marker.

property mouseOver

mouseOver: EventEmitter<google.maps.MouseEvent>;

• This event is fired when the user mouses over the marker.

property opacity

opacity: number;

• The marker's opacity between 0.0 and 1.0.

property openInfoWindow

openInfoWindow: boolean;

• Whether to automatically open the child info window when the marker is clicked.

property title

title: string;

• The title of the marker.

property visible

visible: boolean;

• If true, the marker is visible

property zIndex

zIndex: number;

• All markers are displayed on the map in order of their zIndex, with higher values displaying in front of markers with lower values. By default, markers are displayed according to their vertical position on screen, with lower markers appearing in front of markers further up the screen.

method ngAfterContentInit

ngAfterContentInit: () => void;

method getOptions

getOptions: () => google.maps.MapOptions;