woosmap_flutter
library
Classes
AddressComponents
Represents address of the locality
@memberOf woosmap.map.localities
APIHelper
A helper class for making API requests and handling responses.
AutocompleteMatchedSubstring
@memberOf woosmap.map
Bounds
Represents the bounds of a route.
DirectionParameter
This Class represented API input structure to fetch indoor direction between two location.
It has been deprecated. Please use IndoorDirectionRequest .
DirectionRequest
This Class represented API input structure to fetch indoor direction between two location
Please refer DirectionRequest documentation for more details.
DirectionsWayPoint
Directions WayPoint
Distance
Represents a class for interacting with the Woosmap Distance API.
DistanceIsochroneRequest
Represents API request parameters for the Distance API isochrone endpoint.
DistanceIsochroneResponse
Represents the response from the Distance API isochrone endpoint.
DistanceIsoline
Represents the isochrone isoline details.
DistanceMatrixElement
Represents an element containing distance and duration information.
DistanceMatrixRequest
Represents API request parameters for the Distance Matrix API.
DistanceMatrixResponse
Represents the response from the Distance Matrix API.
DistanceMatrixRow
Represents a row in the Distance Matrix API response.
DistanceRouteRequest
Represents API request parameters for the Distance API route endpoint.
DistanceRouteResponse
Represents the response from the Distance API route endpoint.
DistanceTollRoute
Represents a route in the response.
DistanceTollsRequest
Represents API request parameters for the Distance API tolls endpoint.
DistanceTollsResponse
Represents the response from the Distance API tolls endpoint.
DistanceValue
Represents the distance information in the response.
DistanceWaypoints
Represents waypoints for the Distance API request.
DurationValue
Represents the duration information in the response.
EasingAnimation
Enum: EasingAnimation
Fare
Represents a toll fare.
FlyToOptions
The FlyToOptions class is likely used for specifying options related to flying to a destination.
GeoJSONFeature
GeoJSON Feature
GeoJSONPoint
Represents the Point
feature of GeoJSON
IndoorDirectionRequest
This Class represented API input structure to fetch indoor direction between two location
Check docs for more details.
IndoorDirectionsIcons
Icons to indicate origin and destination on route.
Please refer this link for more details.
IndoorPolylineOptions
Indoor polyline customization options
IndoorPosition
IndoorPosition class
IndoorRendererOptions
This class represents options to configure the Indoor Renderer.
Please refer to documentation for more details.
IndoorRendererOptionsIcon
IndoorRenderer Options Icon
IndoorWidgetOptions
A widget configuration json can be added to the IndoorWidget constructor.
Please refer docs for more details.
IndoorWidgetOptionsUI
Represents UI Option of the Indoor widget.
Check docs for more details.
LatLng
This class represent geo location object
LatLngBounds
Instance represents a rectangle in geographical coordinates, including one that crosses the 180 degrees longitudinal meridian.
LatLngBoundsLiteral
Padding around given rectangular
LatLngLiteral
This class represent geo location object
Leg
Represents a leg of a route.
LegDistance
Represents distance information.
LegDuration
Represents duration information.
Localities
Represents a class for interacting with the Woosmap Localities API.
LocalitiesAutocompleteRequest
Localities Autocomplete Request
LocalitiesAutocompleteResponse
A Localities Autocomplete response returned by the call to
Localities.autocomplete
containing a
list of LocalitiesPredictions .
@memberOf woosmap.map.localities
LocalitiesCategory
enum : Localities Category
LocalitiesComponentRestrictions
Restricts predictions to the specified country (ISO 3166-1 Alpha-2 or Alpha-3 compatible country code, case-insensitive).
For example, 'FR', 'GB', or 'DE'. You can provide a single one, or an array of country code strings.
@memberOf woosmap.map.localities
LocalitiesDetails
Represents localities detail in the LocalitiesDetailsResponse
LocalitiesDetailsGeometry
Details geometry, contains a location and optionally bounds viewport.
@memberOf woosmap.map.localities
LocalitiesDetailsRequest
Localities Details Request
LocalitiesDetailsResponse
A Localities details response returned by the call to
Localities.details
containing a
Object of LocalitiesDetails .
@memberOf woosmap.map.localities
LocalitiesDetailsSummary
Represents a sub building in reverse geocoding request.
LocalitiesGeocodeGeometry
Represents the geometry in the Localities geocode results
LocalitiesGeocodeLocationType
Defines the type of the returned geocoded element.
@memberOf woosmap.map.localities
LocalitiesGeocodeRequest
Localities Geocode Request
LocalitiesGeocodeResponse
A Localities Geocode response returned by the call to
Localities.geocode
containing a
list of LocalitiesGeocodeResult .
@memberOf woosmap.map.localities
LocalitiesGeocodeResult
Defines information about a Geocoded Locality.
@memberOf woosmap.map.localities
LocalitiesNearByCategory
enum : Localities nearby Category
LocalitiesNearbyRequest
Localities Nearby Request
LocalitiesNearbyResponse
Represents the response from the Localities Nearby API.
For more check https://developers.woosmap.com/products/localities/nearby/#response
LocalitiesNearbyResult
Represents a single locality result from the Localities Nearby API.
LocalitiesNearbyTypes
Enum for Localities Nearby Types
Currently, only point_of_interest
is supported.
LocalitiesPredictions
Represents a single locality prediction
@memberOf woosmap.map.localities
LocalitiesRelated
Represents related components information for a prediction.
LocalitiesRelatedPostalCode
Represents a related postal code information for a prediction.
LocalitiesSearchRequest
Search for suggestions given a text-based geographic query.
LocalitiesSearchResponse
Represents the response from the Localities search API.
For more check https://developers.woosmap.com/products/localities/search/#response
LocalitiesSearchResult
Locality Result Object
LocalitiesTypes
The types of suggestion to return.
By default, suggestions return types locality
and postal_code
.
Check full list of supported types
@memberOf woosmap.map.localities
MapOptions
MapOptions object is used to define the properties that can be set on a Map.
Please refer docs for more details.
MapStyler
The MapStyler interface.
MapStyleSpec
Represents MapStyleSpec object
Marker
Display markers to identify locations on Woosmap Map.
MarkerLabelOptions
Represents MarkerLabelOptions interface
MarkerOptions
Class to configure marker properties.
Please refer docs for more details.
Represents pagination details in the Localities Nearby API response.
A Pagination class which exposes page
and total pageCount
properties.
Pass
Represents a toll pass, including return journey details and validity period.
PointLiteral
PointLiteral
Price
Represents a toll price.
Route
Represents a route in the response.
RouteLeg
Represents a leg of a route.
Store
Defines information about a Store.
@memberOf woosmap.map.stores
StoreAddress
Defines information about a store address.
@memberOf woosmap.map.stores
StoreContact
Defines information about a store contact.
@memberOf woosmap.map.stores
StoreOpen
Defines the current opening status for a store
@memberOf woosmap.map.stores
StoreOpeningHours
Describes the opening hours of a store.
@memberOf woosmap.map.stores
StoreOpeningHoursPeriod
Defines the hours for an opening period.
To set a slice of time when the asset is open you must define a start
and end
keys.
start
and end
must belong to the same day (crossing midnight may result in open_now
being always false
.)
@memberOf woosmap.map.stores
StoreOpeningHoursUsual
Defines the usual opening hours of a store.
The key defines the day number. It can be from "1" for monday up to "7" for sunday.
@memberOf woosmap.map.stores
StoreOpenNextOpening
Defines the next opening hours period
@memberOf woosmap.map.stores
StoreOverlay
Display your Stores
StorePrediction
Represents a single store prediction.
@memberOf woosmap.map.stores
StoreResponse
A Store Response as a GeoJSON Feature Object returned by the call to
StoresService.getStoreById
@memberOf woosmap.map.stores
Stores
Class that represents a collection of Stores APIs
StoresAutocompleteRequest
A Stores Autocomplete request to be sent to StoresService.autocomplete
containing
a search query as string with localized
field to autocomplete stores on localizedNames
.
@memberOf woosmap.map.stores
StoresAutocompleteResponse
A Stores Autocomplete response returned by the call to
StoresService.autocomplete
containing a
list of StorePrediction
.
@memberOf woosmap.map.stores
StoresSearchRequest
A Stores Search request to be sent to StoresService.search
containing
a search query as string to autocomplete stores on.
@memberOf woosmap.map.stores
StoresSearchResponse
A Stores Search response as a GeoJSON FeatureCollection Object returned by the call to
StoresService.search
and containing a list of StoreResponse
.
@memberOf woosmap.map.stores
StoreWeeklyOpening
Defines the current Weekly Opening taking into account the special hours.
The key defines the day number. It can be from "1" for monday up to "7" for sunday.
@memberOf woosmap.map.stores
StoreWeeklyOpeningHoursPeriod
Defines the weekly opening hours of a store.
@memberOf woosmap.map.stores
Style
Represents a style object that defines the styling rules for a specific breakpoint.
StyleRule
Represents the StyleRule interface.
Toll
Represents toll information.
TollCollectionLocation
Represents a toll collection location.
TollSystem
Represents a toll system.
Transit
Represents a class for interacting with the Woosmap Transit API.
TransitAttribution
Identifier for the attribution
TransitLeg
Transit Leg
TransitPlace
Transit Place
TransitRoute
Transit Route
TransitRouteRequest
Represents API request parameters for the Transit API route endpoint.
TransitRouteResponse
Represents API request parameters for the Transit API route endpoint.
TransitTransport
Transit Transport
Transponder
Represents a transponder system.
TypedStyleRule
Represents a typed style rule with properties for color, icon, selected icon, and type.
ValidityPeriod
Represents the validity period of a toll pass.
Viewport
The geographical viewport with bounds.
WoosIcon
Represents Icon interface
WoosKey
A data holder class which holds Woosmap private and public keys
WoosmapApi
The primary class which encapsulates the Stores , Distance , Transit and Localities objects
WoosmapController
This class represent interaction between Indoor map and application
WoosmapFlutter
Woosmap flutter plugin
WoosmapMapViewWidget
WoosmapMapViewWidget is UI represent Indoor map and its interaction
WoosPadding
Padding around given rectangular
WoosPoint
Represents Point class
WoosSize
Represents Size class.