Description

Represents the functionality that a polyline wrapper should provide.

Extends

IGoogleMapsDrawableOverlay

Index

overlays/modules/polyline/i-google-maps-polyline.ts

Methods

Methods

getPath
getPath()
Returns: google.maps.LatLngLiteral[]
setClickable
setClickable(clickable: boolean)
Parameters:
Name Type Optional
clickable boolean No
Returns: void
setGeodesic
setGeodesic(geodesic: boolean)
Parameters:
Name Type Optional
geodesic boolean No
Returns: void
setPath
setPath(coords: Path)
Parameters:
Name Type Optional
coords Path No
Returns: void
setStrokeColor
setStrokeColor(color: string)
Parameters:
Name Type Optional
color string No
Returns: void
setStrokeOpacity
setStrokeOpacity(opacity: number)
Parameters:
Name Type Optional
opacity number No
Returns: void
setStrokeWeight
setStrokeWeight(weight: number)
Parameters:
Name Type Optional
weight number No
Returns: void
setZIndex
setZIndex(zIndex: number)
Parameters:
Name Type Optional
zIndex number No
Returns: void
import { Path, WrappedNativeFunctions } from '@bespunky/angular-google-maps/core';
import { IGoogleMapsDrawableOverlay } from '../../abstraction/base/i-google-maps-drawable-overlay';

/** A type for the native functions of an polyline which should be wrapped. Used along with the extension interface for the wrapper. */
export type WrappedPolylineFunctions = WrappedNativeFunctions<google.maps.Polyline, 'getPath' | 'setPath' | 'addListener' | 'bindTo' | 'unbind' | 'unbindAll' | 'notify' | 'getMap' | 'setMap' | 'get' | 'set'>;

/**
 * Represents the functionality that a polyline wrapper should provide.
 *
 * @export
 * @interface IGoogleMapsPolyline
 * @extends {IGoogleMapsDrawableOverlay<google.maps.Polyline>}
 * @extends {WrappedPolylineFunctions}
 */
export interface IGoogleMapsPolyline extends IGoogleMapsDrawableOverlay<google.maps.Polyline>, WrappedPolylineFunctions
{
    getPath(): google.maps.LatLngLiteral[];
    setPath(coords: Path): void;

    // Options delegators
    setClickable     (clickable: boolean)                  : void;
    setStrokeColor   (color: string)                       : void;
    setStrokeOpacity (opacity: number)                     : void;
    setStrokeWeight  (weight: number)                      : void;
    setZIndex        (zIndex: number)                      : void;
    setGeodesic      (geodesic: boolean)                   : void;
}

results matching ""

    No results matching ""