TKPlace

 
@interface TKPlace : NSObject

Basic Place model keeping various information about its properties.

Hard properties
  • ID

    Global identifier.

    Note

    You can find IDs of countries in Google Sheets or CSV file, you can also find IDs of top cities in Google Sheets and CSV file as well.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NS_SWIFT_NAME(ID) NSString *ID;

    Swift

    var ID: String { get }

  • Displayable name of the place, translated if possible. Example: Buckingham Palace.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull name;

    Swift

    var name: String { get }

  • Displayable name suffix. Example: London, United Kingdom.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *suffix;

    Swift

    var suffix: String? { get }

  • Denotable place level. Each place has a level property that describes the type of the place by administration level.

    See

    TKPlaceLevel

    Declaration

    Objective-C

    @property (readonly) TKPlaceLevel level;

    Swift

    var level: TKPlaceLevel { get }

  • Short perex introducing the place.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *perex;

    Swift

    var perex: String? { get }

  • Location of the place.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) CLLocation *_Nonnull location;

    Swift

    var location: CLLocation { get }

  • 18-character Quad key representing map tile coordinate using Mercator (Google/Bing) projection. For details see Bing Maps docs or maptiler.org .

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *quadKey;

    Swift

    var quadKey: String? { get }

  • Bounding box. Object with south-west and north-east point in degrees. Specifies bounds of places that have an area.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) TKMapRegion *boundingBox;

    Swift

    var boundingBox: TKMapRegion? { get }

  • Global rating value.

    Note

    Possible values: double in range 0–10.0.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSNumber *rating;

    Swift

    var rating: NSNumber? { get }

  • Stringified type intended to be shown in the UI, e.g. ‘Playground’, ‘Post Office’, ‘ATM’ etc.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *kind;

    Swift

    var kind: String? { get }

  • Marker identifier usable for displayable icon. For more information please see Sygic Travel API .

    Note

    For a full list of all available markers see Markers sheet

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *marker;

    Swift

    var marker: String? { get }

  • List of Category slugs assigned. For more information please see Sygic Travel API .

    See

    TKPlaceCategory

    Declaration

    Objective-C

    @property (readonly) TKPlaceCategory categories;

    Swift

    var categories: TKPlaceCategory { get }

  • List of Parent IDs. Parent IDs are IDs of other places. These parent places can be for example the geographical units the place is part of. This can be useful when working with a map, searching for cities by location, etc.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSArray<NSString *> *parents;

    Swift

    var parents: [String]? { get }

  • List of custom flags.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSArray<NSString *> *flags;

    Swift

    var flags: [String]? { get }

  • Thumbnail URL to an image of size 150×150 pixels.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSURL *thumbnailURL;

    Swift

    var thumbnailURL: URL? { get }

Helping properties

  • Default HEX colour value. Values 0x000000 through 0xFFFFFF.

    Declaration

    Objective-C

    @property (readonly) NSUInteger displayableHexColor;

    Swift

    var displayableHexColor: UInt { get }