GMSAutocompletePlaceSuggestion クラス リファレンス

GMSAutocompletePlaceSuggestion クラス リファレンス

概要

このクラスは、部分的に型付けされた文字列に基づいて、完全なクエリの場所候補を示します。

プロパティ

NSAttributedString *attributedFullText
 NSAttributedString 形式の候補の詳細な説明。
NSAttributedString *attributedPrimaryText
 NSAttributedString として指定する候補のメインテキスト。通常は、場所の名前です。
NSAttributedString *attributedSecondaryText
 NSAttributedString として指定する候補のセカンダリ テキスト。通常は場所の所在地です。
NSString * placeID
 候補のプレイス ID を表すプロパティ。Place Details リクエストで使用するのに適しています。
NSArray<NSString * >*types
 予測入力の結果タイプ。
NSNumber *distanceMeters
 リクエストの GMSAutocompleteFilter で有効な起点が指定されている場合は、この起点とこの候補間の直線距離(メートル単位)。

プロパティのドキュメント

- (NSAttributedString*) attributedFullText [read, copy]

NSAttributedString 形式の候補の詳細な説明。

例: 「シドニー オペラハウス、 シドニー、ニュー サウス ウェールズ州、オーストラリア」。

ユーザー入力と一致するすべてのテキスト範囲に kGMSAutocompleteMatchAttribute があります。たとえば、enumerateAttribute を使用してすべての一致を太字にすることができます。

   UIFont *regularFont = [UIFont systemFontOfSize:[UIFont labelFontSize]];
   UIFont *boldFont = [UIFont boldSystemFontOfSize:[UIFont labelFontSize]];
   NSMutableAttributedString *bolded = [suggestion.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]

NSAttributedString として指定する候補のメインテキスト。通常は、場所の名前です。

例:「シドニー オペラハウス」。

ユーザー入力と一致するテキスト範囲には kGMSAutocompleteMatchAttribute が付いています(例: attributedFullText)。

- (NSAttributedString*) attributedSecondaryText [read, copy]

NSAttributedString として指定する候補のセカンダリ テキスト。通常は場所の所在地です。

例:「シドニー、ニュー サウス ウェールズ、オーストラリア」。

ユーザー入力と一致するテキスト範囲には kGMSAutocompleteMatchAttribute が付いています(例: attributedFullText)。

nil も可能です。

- (NSString*) placeID [read, copy]

候補のプレイス ID を表すプロパティ。Place Details リクエストで使用するのに適しています。

- (NSArray<NSString *>*) types [read, copy]

予測入力の結果タイプ。

型は NSStrings で、有効な値は、<https://developers.google.com/places/ios-sdk/supported_types> に記載されているすべての型です。

- (NSNumber*) distanceMeters [read, assign]

リクエストの GMSAutocompleteFilter で有効な起点が指定されている場合は、この起点とこの候補間の直線距離(メートル単位)。