Represents a Place.
Package
@googlemaps/placesConstructors
(constructor)(properties)
constructor(properties?: google.maps.places.v1.IPlace);Constructs a new Place.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPlace
Properties to set |
Properties
_accessibilityOptions
public _accessibilityOptions?: "accessibilityOptions";Place _accessibilityOptions.
_allowsDogs
public _allowsDogs?: "allowsDogs";Place _allowsDogs.
_curbsidePickup
public _curbsidePickup?: "curbsidePickup";Place _curbsidePickup.
_delivery
public _delivery?: "delivery";Place _delivery.
_dineIn
public _dineIn?: "dineIn";Place _dineIn.
_goodForChildren
public _goodForChildren?: "goodForChildren";Place _goodForChildren.
_goodForGroups
public _goodForGroups?: "goodForGroups";Place _goodForGroups.
_goodForWatchingSports
public _goodForWatchingSports?: "goodForWatchingSports";Place _goodForWatchingSports.
_liveMusic
public _liveMusic?: "liveMusic";Place _liveMusic.
_menuForChildren
public _menuForChildren?: "menuForChildren";Place _menuForChildren.
_outdoorSeating
public _outdoorSeating?: "outdoorSeating";Place _outdoorSeating.
_reservable
public _reservable?: "reservable";Place _reservable.
_restroom
public _restroom?: "restroom";Place _restroom.
_servesBeer
public _servesBeer?: "servesBeer";Place _servesBeer.
_servesBreakfast
public _servesBreakfast?: "servesBreakfast";Place _servesBreakfast.
_servesBrunch
public _servesBrunch?: "servesBrunch";Place _servesBrunch.
_servesCocktails
public _servesCocktails?: "servesCocktails";Place _servesCocktails.
_servesCoffee
public _servesCoffee?: "servesCoffee";Place _servesCoffee.
_servesDessert
public _servesDessert?: "servesDessert";Place _servesDessert.
_servesDinner
public _servesDinner?: "servesDinner";Place _servesDinner.
_servesLunch
public _servesLunch?: "servesLunch";Place _servesLunch.
_servesVegetarianFood
public _servesVegetarianFood?: "servesVegetarianFood";Place _servesVegetarianFood.
_servesWine
public _servesWine?: "servesWine";Place _servesWine.
_takeout
public _takeout?: "takeout";Place _takeout.
_userRatingCount
public _userRatingCount?: "userRatingCount";Place _userRatingCount.
_utcOffsetMinutes
public _utcOffsetMinutes?: "utcOffsetMinutes";Place _utcOffsetMinutes.
accessibilityOptions
public accessibilityOptions?: (google.maps.places.v1.Place.IAccessibilityOptions|null);Place accessibilityOptions.
addressComponents
public addressComponents: google.maps.places.v1.Place.IAddressComponent[];Place addressComponents.
adrFormatAddress
public adrFormatAddress: string;Place adrFormatAddress.
allowsDogs
public allowsDogs?: (boolean|null);Place allowsDogs.
areaSummary
public areaSummary?: (google.maps.places.v1.Place.IAreaSummary|null);Place areaSummary.
attributions
public attributions: google.maps.places.v1.Place.IAttribution[];Place attributions.
businessStatus
public businessStatus: (google.maps.places.v1.Place.BusinessStatus|keyof typeof google.maps.places.v1.Place.BusinessStatus);Place businessStatus.
curbsidePickup
public curbsidePickup?: (boolean|null);Place curbsidePickup.
currentOpeningHours
public currentOpeningHours?: (google.maps.places.v1.Place.IOpeningHours|null);Place currentOpeningHours.
currentSecondaryOpeningHours
public currentSecondaryOpeningHours: google.maps.places.v1.Place.IOpeningHours[];Place currentSecondaryOpeningHours.
delivery
public delivery?: (boolean|null);Place delivery.
dineIn
public dineIn?: (boolean|null);Place dineIn.
displayName
public displayName?: (google.type.ILocalizedText|null);Place displayName.
editorialSummary
public editorialSummary?: (google.type.ILocalizedText|null);Place editorialSummary.
evChargeOptions
public evChargeOptions?: (google.maps.places.v1.IEVChargeOptions|null);Place evChargeOptions.
formattedAddress
public formattedAddress: string;Place formattedAddress.
fuelOptions
public fuelOptions?: (google.maps.places.v1.IFuelOptions|null);Place fuelOptions.
generativeSummary
public generativeSummary?: (google.maps.places.v1.Place.IGenerativeSummary|null);Place generativeSummary.
goodForChildren
public goodForChildren?: (boolean|null);Place goodForChildren.
goodForGroups
public goodForGroups?: (boolean|null);Place goodForGroups.
goodForWatchingSports
public goodForWatchingSports?: (boolean|null);Place goodForWatchingSports.
googleMapsUri
public googleMapsUri: string;Place googleMapsUri.
iconBackgroundColor
public iconBackgroundColor: string;Place iconBackgroundColor.
iconMaskBaseUri
public iconMaskBaseUri: string;Place iconMaskBaseUri.
id
public id: string;Place id.
internationalPhoneNumber
public internationalPhoneNumber: string;Place internationalPhoneNumber.
liveMusic
public liveMusic?: (boolean|null);Place liveMusic.
location
public location?: (google.type.ILatLng|null);Place location.
menuForChildren
public menuForChildren?: (boolean|null);Place menuForChildren.
name
public name: string;Place name.
nationalPhoneNumber
public nationalPhoneNumber: string;Place nationalPhoneNumber.
outdoorSeating
public outdoorSeating?: (boolean|null);Place outdoorSeating.
parkingOptions
public parkingOptions?: (google.maps.places.v1.Place.IParkingOptions|null);Place parkingOptions.
paymentOptions
public paymentOptions?: (google.maps.places.v1.Place.IPaymentOptions|null);Place paymentOptions.
photos
public photos: google.maps.places.v1.IPhoto[];Place photos.
plusCode
public plusCode?: (google.maps.places.v1.Place.IPlusCode|null);Place plusCode.
priceLevel
public priceLevel: (google.maps.places.v1.PriceLevel|keyof typeof google.maps.places.v1.PriceLevel);Place priceLevel.
primaryType
public primaryType: string;Place primaryType.
primaryTypeDisplayName
public primaryTypeDisplayName?: (google.type.ILocalizedText|null);Place primaryTypeDisplayName.
rating
public rating: number;Place rating.
regularOpeningHours
public regularOpeningHours?: (google.maps.places.v1.Place.IOpeningHours|null);Place regularOpeningHours.
regularSecondaryOpeningHours
public regularSecondaryOpeningHours: google.maps.places.v1.Place.IOpeningHours[];Place regularSecondaryOpeningHours.
reservable
public reservable?: (boolean|null);Place reservable.
restroom
public restroom?: (boolean|null);Place restroom.
reviews
public reviews: google.maps.places.v1.IReview[];Place reviews.
servesBeer
public servesBeer?: (boolean|null);Place servesBeer.
servesBreakfast
public servesBreakfast?: (boolean|null);Place servesBreakfast.
servesBrunch
public servesBrunch?: (boolean|null);Place servesBrunch.
servesCocktails
public servesCocktails?: (boolean|null);Place servesCocktails.
servesCoffee
public servesCoffee?: (boolean|null);Place servesCoffee.
servesDessert
public servesDessert?: (boolean|null);Place servesDessert.
servesDinner
public servesDinner?: (boolean|null);Place servesDinner.
servesLunch
public servesLunch?: (boolean|null);Place servesLunch.
servesVegetarianFood
public servesVegetarianFood?: (boolean|null);Place servesVegetarianFood.
servesWine
public servesWine?: (boolean|null);Place servesWine.
shortFormattedAddress
public shortFormattedAddress: string;Place shortFormattedAddress.
subDestinations
public subDestinations: google.maps.places.v1.Place.ISubDestination[];Place subDestinations.
takeout
public takeout?: (boolean|null);Place takeout.
types
public types: string[];Place types.
userRatingCount
public userRatingCount?: (number|null);Place userRatingCount.
utcOffsetMinutes
public utcOffsetMinutes?: (number|null);Place utcOffsetMinutes.
viewport
public viewport?: (google.geo.type.IViewport|null);Place viewport.
websiteUri
public websiteUri: string;Place websiteUri.
Methods
create(properties)
public static create(properties?: google.maps.places.v1.IPlace): google.maps.places.v1.Place;Creates a new Place instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPlace
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Place |
Place instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.places.v1.Place;Decodes a Place message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Place |
Place |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.places.v1.Place;Decodes a Place message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Place |
Place |
encode(message, writer)
public static encode(message: google.maps.places.v1.IPlace, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Place message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPlace
Place message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.maps.places.v1.IPlace, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Place message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPlace
Place message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.maps.places.v1.Place;Creates a Place message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Place |
Place |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Place
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Place to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.maps.places.v1.Place, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Place message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Place
Place |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Place message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|