core library

Commonly used entities

Classes

AbstractGeometry Routes & Navigation
AbstractGeometry object.
AbstractGeometryImageRenderSettings Core
Abstract geometry image render settings.
AbstractGeometryImg Maps & 3D Scene
Class used for customizable turn images
AddressInfo Places
Address info class
AlarmListener Routes & Navigation
Alarm listener interface.
AlarmMonitoredArea Routes & Navigation
Alarm monitored area consisting of a GeographicArea and an id.
AlarmService Routes & Navigation
Alarm service class
AlarmsList<T> Routes & Navigation
Geographic coordinates referenced list of item alarms.
ApiErrorService
ApiErrorService provides details about the error related to the last operation
AutoUpdateSettings Core
Configuration for auto update
CircleGeographicArea Core
CircleGeographicArea object.
ClimbSection Routes & Navigation
Climb section
ContactInfo Places
Contact info class
Coordinates Core
Coordinates class
Debug Core
Debug object
EntranceLocations Places
Stores locations & access types for entrances to landmarks.
EVRoute Routes & Navigation
Electric vehicle route class
EVRouteInstruction Routes & Navigation
Electric vehicle route instruction class
EVRouteSegment Routes & Navigation
Electric vehicle segment class
ExternalInfo Places
ExternalInfo object
ExtraInfo Places
Extra info
GemKit Core
GEM SDK global functions.
GemParameter Core
A parameter is a tuple ( key, value, name ).
GenericCategories Core
Generic categories class
GeographicArea Core
This object represents a geographical area on the surface of a WGS 84 Ellipsoid.
ImageHandler Core
Image handler class
Img Maps & 3D Scene
Class used for basic images
ImgBase Core
Base class for images
Landmark Places
Landmark class. This is the core class for location information.
LandmarkAlarmsList Routes & Navigation
Geographic coordinates referenced list of Landmark alarms.
LandmarkCategory Core
Landmark category class
LandmarkJson
Landmark class ideally for setting large amount of landmarks data. eg. for List of Landmarks.
LandmarkPosition Maps & 3D Scene
Coordinate referenced Landmark object.
LandmarkStore Places
Landmark store class
LaneImageRenderSettings Core
Lane image render settings.
LaneImg Maps & 3D Scene
Class used for customizable lane images
Language Core
Complete language specification.
MapViewPathCollection Core
Path collection class
MapViewRoute Routes & Navigation
Mapview route class
MapViewRoutesCollection Routes & Navigation
Mapview Routes collection class
MountInfo
NetworkProvider Core
Network access customization.
OffBoardListener Core
OffBoard Listener
OTRoute Routes & Navigation
Over track route
OverlayItemAlarmsList Routes & Navigation
Geographic coordinates referenced list of OverlayItem alarms.
Pair<T1, T2> Core
A pair consisting of 2 objects
ParameterList Core
Searchable parameters list.
Path Core
Path class
Point3d Core
A point in 3d space, consisting of x, y and z coordinates.
Point4d Core
A point in 4d space, consisting of x, y, z and w coordinates.
PolygonGeographicArea Core
PolygonGeographicArea object.
PositionOrientation Core
The position and orientation of an object in 3D space
PredefinedExtraInfoKey Places
Prefefined custom landmark extra info keys
ProgressListener Core
Interface for implementing progress of async operations (routing, search)
PTAlert Routes & Navigation
Public transport alert class
PTBuyTicketInformation Routes & Navigation
Public transport buy ticket information class.
PTRoute Routes & Navigation
Public transport route class
PTRouteInstruction Routes & Navigation
Public transport route instruction class.
PTRouteSegment Routes & Navigation
Public transport route segment
PTTranslation Routes & Navigation
Public transport translation class
RectangleGeographicArea Core
RectangleGeographicArea object.
RectType<T extends num> Core
A generic type consisting of x, y, width and height coordinates.
RenderableImg Maps & 3D Scene
Renderable image
RoadInfo Routes & Navigation
Road Info object
RoadInfoImg Maps & 3D Scene
Class used for customizable road info images
RoadTypeSection Routes & Navigation
Road type sections
Route Routes & Navigation
Route class
RouteInstruction Routes & Navigation
Route instruction class
RouteInstructionBase Routes & Navigation
Road instruction interface
RouteRenderSettings Routes & Navigation
A class that extends RenderSettings to provide additional rendering settings specifically for routes.
RouteSegment Core
Route segment class
RouteTerrainProfile Routes & Navigation
Route terrain profile
RouteTrafficEvent Routes & Navigation
Route traffic events class
SdkSettings Core
SDK settings class
SdkVersion Core
SDK version representation as four ints and a text string.
SearchableParameterList Core
Searchable parameters list.
SignpostDetails Core
Signpost details class
SignpostImageRenderSettings Core
Signpost image render settings.
SignpostImg Maps & 3D Scene
Class used for customizable signposts images
SignpostItem Core
SignpostItem object.
SizeAndFormat Core
Represents the size and format of an image
SteepSection Routes & Navigation
Steep sections
SurfaceSection Routes & Navigation
Surface sections
TaskHandler Core
A task handler is a reference to a task that is currently running or has been scheduled to run. It can be used to cancel the task.
TilesCollectionGeographicArea Core
TilesCollectionGeographicArea object.
TimeDistance Core
Time distance representation based on meters and seconds.
TimeDistanceCoordinate Core
Timestamp & distance & coordinates structure
TrafficEvent Routes & Navigation
Traffic events class
TransferStatistics Core
Provides data transfer statistics for a specific online service
TurnDetails Routes & Navigation
Turn details class
Version Core
Define the content version with major and minor.
XyType<T extends num> Core
A generic type consisting of x and y coordinates.

Enums

AddressField Places
Address field enumeration
AnchorType Routes & Navigation
The anchor type.
AppTheme
ArrowDirection Routes & Navigation
The arrow direction of the shape.
ArrowType Routes & Navigation
The arrow type of the shape.
ContactInfoFieldType Places
Contact info field type
DriveSide Routes & Navigation
The drive side of the abstract geometry.
EngineMisc Core
Miscellaneous icons
EntranceLocationType Places
Type of an entrance location.
GemError Core
Error codes.
GemIcon Core
SDK icons
GemLoggingLevel Core
The log level for SDK features
GeographicAreaType Core
Types of geographic areas
GetWaypointsOptions Routes & Navigation
Get route waypoints options
Grade Routes & Navigation
Climb grade - UCI based, see https://bicycles.stackexchange.com/questions/1210/how-are-the-categories-for-climbs-decided
ImageFileFormat Core
Enumerates known image file formats.
ImageType Maps & 3D Scene
Type of an image
LandmarkStoreType Places
Landmark store types
MapLanguage Core
Available options for map language selection.
Navigation modifiers
NetworkType Core
Network types enumeration.
OnlineRestrictions Core
Represents online restrictions using bitwise flags.
PathFileFormat Core
Path import supported formats.
PositionQuality Sensor Data Source
Values that represent position data quality.
RealtimeStatus Routes & Navigation
Status of realtime information
Reason Core
Error reason type
RestrictionType Routes & Navigation
The restriction type of the shape.
RoadType Routes & Navigation
Get road type
RouteStatus Routes & Navigation
Status of routing service
RoutingAlgoModifiers
ScriptVariant Core
Script variants
ServiceGroupType Core
Service group enum, including map tiles, traffic, terrain.
ShapeForm Routes & Navigation
The type of the shape. Use the type to render the shape in different width and color.
ShapeType Routes & Navigation
The type of the shape. Use the type to render the shape in different width and color. ShapeType.route should be rendered over ShapeType.street
Status Core
Worldwide road map support status
StepType Routes & Navigation
Step unit type
SurfaceType Routes & Navigation
Get surface type
TrafficEventClass Routes & Navigation
Traffic events classes
TrafficEventImpactZone Routes & Navigation
Traffic event shape
TrafficEventSeverity Routes & Navigation
Traffic event severity enum.
TrafficOnlineRestrictions Routes & Navigation
Restrictions which prevent online service functionality
TrafficTransportMode Routes & Navigation
Affected transport modes for traffic events
TrafficUsage Routes & Navigation
Traffic usage type
TransitType Routes & Navigation
Type of transit
TurnEvent Routes & Navigation
Navigation turn events
UnitSystem Core
Unit system
ValueType Core
Types of values.
ViewOnlineServiceType
Online service type for which the view can generate data transfer statistics

Extensions

AppThemeExtension on AppTheme
OnlineRestrictionsExtension on OnlineRestrictions

Exceptions / Errors

GemKitUninitializedException Core
Exception thrown when GemKit is not initialized
ObjectNotAliveException Core
Exception thrown when an object is not alive