CartoType iOS API 7.8.2, 2022-03-25
for development in Swift and Objective C for iOS and Mac OS
Instance Methods | Properties | List of all members
CartoTypeFindParam Class Reference

#import <CartoTypeBase.h>

Inheritance diagram for CartoTypeFindParam:

Instance Methods

(id) - init
 
(id) - initWithPOIType:text:location:
 

Properties

int maxObjectCount
 
CartoTypeGeometryclip
 
CartoTypeGeometrylocation
 
NSString * layers
 
NSString * attributes
 
NSString * text
 
CartoTypeStringMatchMethod stringMatchMethod
 
NSString * condition
 
bool merge
 
double timeOut
 

Detailed Description

Parameters for the general find function.

Method Documentation

◆ init

- (id) init

The default initializer.

◆ initWithPOIType:text:location:

- (id) initWithPOIType: (CartoTypePointOfInterestType aPOIType
text: (NSString *)  aText
location: (CartoTypeGeometry *)  aLocation 

Creates find parameters for finding nearby.

Property Documentation

◆ attributes

- (NSString*) attributes
readwritenonatomicstrong

If 'attributes' is null or empty, search all the attributes, otherwise it is a list of attributes separated by spaces or commas; use '$' to indicate the label (the unnamed attribute).

◆ clip

- (CartoTypeGeometry*) clip
readwritenonatomicassign

The clip path; no clipping is done if clip is empty.

◆ condition

- (NSString*) condition
readwritenonatomicstrong

If non-null, a condition expression (e.g., "Type==2") which must be fulfilled by all the objects.

◆ layers

- (NSString*) layers
readwritenonatomicstrong

If non-null, a list separated by spaces or commas. If it is null all layers are searched.

◆ location

- (CartoTypeGeometry*) location
readwritenonatomicassign

The current location. If it is non-empty, objects in or near this region are preferred. It may be a single point.

◆ maxObjectCount

- (int) maxObjectCount
readwritenonatomicassign

The maximum number of objects to return.

◆ merge

- (bool) merge
readwritenonatomicassign

If merge is true (the default), adjoining objects with the same name and attributes may be merged into a single object.

◆ stringMatchMethod

- (CartoTypeStringMatchMethod) stringMatchMethod
readwritenonatomicassign

The string matching method used for text searching.

◆ text

- (NSString*) text
readwritenonatomicstrong

If non-null, restricts the search to objects containing a string in one of their string attributes.

◆ timeOut

- (double) timeOut
readwritenonatomicassign

The maximum time in seconds allowed for a find operation. Find operations are not guaranteed to return in this time or less, but will attempt to do so.


The documentation for this class was generated from the following file: