TKPlace

 
@interface TKPlace : NSObject

Basic Place model keeping various information about its properties.

Hard properties
  • ID

    Global identifier.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *_Nonnull ID;

    Swift

    var ID: String { get set }

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

    Declaration

    Objective-C

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

    Swift

    var name: String { get set }

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

    Declaration

    Objective-C

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

    Swift

    var suffix: String? { get set }

  • Denotable place level.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) TKPlaceLevel level;

    Swift

    var level: TKPlaceLevel { get set }

  • Short perex introducing the place.

    Declaration

    Objective-C

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

    Swift

    var perex: String? { get set }

  • Location of the place.

    Declaration

    Objective-C

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

    Swift

    var location: CLLocation { get set }

  • 18-character Quad key.

    Declaration

    Objective-C

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

    Swift

    var quadKey: String? { get set }

  • Bounding box.

    Declaration

    Objective-C

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

    Swift

    var boundingBox: TKMapRegion? { get set }

  • Global rating value.

    Note

    Possible values: double in range 0–10.0.

    Declaration

    Objective-C

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

    Swift

    var rating: NSNumber? { get set }

  • Marker identifier usable for displayable icon.

    Declaration

    Objective-C

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

    Swift

    var marker: String? { get set }

  • List of Category slugs assigned.

    See

    TKPlaceCategory

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) TKPlaceCategory categories;

    Swift

    var categories: TKPlaceCategory { get set }

  • List of Parent IDs.

    Declaration

    Objective-C

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

    Swift

    var parents: [String]? { get set }

  • List of custom flags.

    Declaration

    Objective-C

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

    Swift

    var flags: [String]? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var thumbnailURL: URL? { get set }

  • Place detail of TKPlaceDetail instance containing further attributes.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) TKPlaceDetail *detail;

    Swift

    var detail: TKPlaceDetail? { get set }

Helping properties

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

    Declaration

    Objective-C

    @property (readonly, atomic) NSUInteger displayableHexColor;

    Swift

    var displayableHexColor: UInt { get }