Overview
This class represents a prediction of a full query based on a partially typed string.
Properties | |
NSAttributedString * | attributedFullText |
The full description of the prediction as a NSAttributedString. | |
NSAttributedString * | attributedPrimaryText |
The main text of a prediction as a NSAttributedString, usually the name of the place. | |
NSAttributedString * | attributedSecondaryText |
The secondary text of a prediction as a NSAttributedString, usually the location of the place. | |
NSString * | placeID |
A property representing the place ID of the prediction, suitable for use in a place details request. | |
NSArray< NSString * > * | types |
The types of this autocomplete result. | |
NSNumber * | distanceMeters |
The straight line distance in meters between the origin and this prediction if a valid origin is specified in the GMSAutocompleteFilter of the request. | |
Related Functions | |
(Note that these are not member functions.) | |
NSString *const | kGMSAutocompleteMatchAttribute |
Attribute name for match fragments in GMSAutocompletePrediction attributedFullText. |
Friends And Related Function Documentation
- (NSString* const) kGMSAutocompleteMatchAttribute [related] |
Attribute name for match fragments in GMSAutocompletePrediction
attributedFullText.
Property Documentation
- (NSAttributedString*) attributedFullText [read, copy] |
The full description of the prediction as a NSAttributedString.
E.g., "Sydney Opera House, Sydney, New South Wales, Australia".
Every text range that matches the user input has a kGMSAutocompleteMatchAttribute
. For example, you can make every match bold using enumerateAttribute:
UIFont *regularFont = [UIFont systemFontOfSize:[UIFont labelFontSize]]; UIFont *boldFont = [UIFont boldSystemFontOfSize:[UIFont labelFontSize]];
NSMutableAttributedString *bolded = [prediction.attributedFullText mutableCopy]; [bolded enumerateAttribute:kGMSAutocompleteMatchAttribute inRange:NSMakeRange(0, bolded.length) options:0 usingBlock:^(id value, NSRange range, BOOL *stop) { UIFont *font = (value == nil) ? regularFont : boldFont; [bolded addAttribute:NSFontAttributeName value:font range:range]; }];
label.attributedText = bolded;
- (NSAttributedString*) attributedPrimaryText [read, copy] |
The main text of a prediction as a NSAttributedString, usually the name of the place.
E.g. "Sydney Opera House".
Text ranges that match user input are have a kGMSAutocompleteMatchAttribute
, like attributedFullText
.
- (NSAttributedString*) attributedSecondaryText [read, copy] |
The secondary text of a prediction as a NSAttributedString, usually the location of the place.
E.g. "Sydney, New South Wales, Australia".
Text ranges that match user input are have a kGMSAutocompleteMatchAttribute
, like attributedFullText
.
May be nil.
- (NSString*) placeID [read, copy] |
A property representing the place ID of the prediction, suitable for use in a place details request.
- (NSArray<NSString *>*) types [read, copy] |
The types of this autocomplete result.
Types are NSStrings, valid values are any types documented at <https://developers.google.com/places/ios-sdk/supported_types>.
- (NSNumber*) distanceMeters [read, assign] |
The straight line distance in meters between the origin and this prediction if a valid origin is specified in the GMSAutocompleteFilter
of the request.