Class MMSearch

Object
   |
   +--MMSearch

class MMSearch

Defined in MultimapAPI

Field Detail

address

MMAddress address

Specifies an address to search from.
Default: none

bounding_box

MMBounds bounding_box

Specifies a bounding box that limits the area in which a search can take place.
Default: none

compound_order

String compound_order

Comma separated list specifying the order in which individual operators should be applied when using the "com" (compound) search operator within an MMSearchFilter.
Permitted values: eq, contains, startswith, endswith, like, sl, co
Default: 'eq,contains,sl'

compound_threshold

integer compound_threshold

Specifies the number of records the compound search operator should try to retrieve. If set to 0, the compound query will halt as soon as one of the individual operators matches at least 1 row. If set to 10, the compound query will continue to run until at least 10 matches are found, or there are no more operators to use.
Default: none

count

integer count

Specifies the number of records to return.
Default: 20

data_source

String data_source

The data source to be queried when the search executes. Can be a comma-separated list searching multiple data sources in one request. Each data source will have its own record set returned.
Default: Data source of Multimap API client name

distance_units

String distance_units

Specifies the units to use in conjunction with max_distance and min_distance.
Permitted values: 'miles', 'km'
Default: 'miles'

endpoint

Object endpoint

filters

Array filters

Array of MMSearchFilter for filtering results using non-spatial values.
Default: none

format

String format

Specifies whether to return all record details or only the count of the records returned.
Permitted values: 'normal', 'compact'
Default: 'normal'

locale

Object locale

logic

String logic

Comma separated list of logic operator to use when more than one value for 'filters' is provided.
Permitted values: 'AND', 'OR'
Default: 'AND'

max_distance

float max_distance

Limits the search results to those within a certain distance of the point, address or pre_search.
Default: none

min_distance

float min_distance

Limits the search results to those outside a certain distance from the point or address.
Default: none

morton

Object morton

order_by_fields

Array order_by_fields

Array of strings containing fields to be used to order the search results. Can also be a comma-separated list of fields.
Default: 'distance'

order_by_order

Array order_by_order

Array of order direction values to match up with fields provided in order_by_fields. Can also be a comma-separated list.
Permitted values: 'asc', 'desc'
Default: 'asc'

point

MMLatLon point

Specifies a lat/lon point to search from.
Default: none

pre_search

MMSearch pre_search

A MMSearch object whose results can be used as the source for another search.
Default: none

result_set_size

integer result_set_size

Used when point queries also have order by settings to first get a result set of the specified size sorted by distance from the point before doing the order bys.
Default: none

return_fields

Array return_fields

Array of fields to return in the search results. Can also be a comma-separated list.
Default: all fields

route_modes

String route_modes

/** Comma separated list specifying routing modes, calculates and adds routed distances and durations to all search results.
Permitted values: driving, walking
Default: 'eq,contains,sl'

start_index

integer start_index

Specifies the index of the first record to display.
Default: 1

MMSearch

MMSearch( <Object> init_search )

The Multimap API Searching module - JavaScript library.
JavaScript library for accessing the functionality of the Multimap API Searching module.
Requires access to the Multimap API Searching module - please contact your Multimap account manager for further information.
The input parameter can be one of the following:
• A JSON object to initialize MMSearch with. See field summary for further information.
• A MMBounds object to use as the bounding_box field
• A MMAddress object to use as the address field
• A MMSearchFilter object which will be the only element in the filters array
• A MMLatLon object to be used as the point field
• A MMSearch object to be used as the pre_search field

Parameters:
init_search - Described above.

copy

MMSearch copy()

Makes a new MMSearch object containing a copy of the data within this one.

Returns:
A new MMSearch object containing a copy of the data within this one.

toString

String toString()

Function to return a simple string representation of the object.

Returns:
A stringified dump of the attributes of the object.