IndoorSettings Class Reference

Inherits from NSObject
Declared in IndoorSettings.h

Overview

Internal map Information

+ instance

Internal map properties

+ (nonnull IndoorSettings *)instance

Discussion

Internal map properties

@return

Declared In

IndoorSettings.h

+ createNewMap:

New Map instance

+ (nonnull instancetype)createNewMap:(nonnull NSDictionary *)details

Parameters

details

Map configurations dictionary @return

Discussion

New Map instance

Declared In

IndoorSettings.h

– FloorName:

Floor name for map

- (nonnull NSString *)FloorName:(int)ioFloor

Parameters

ioFloor

internal floor @return

Discussion

Floor name for map

Declared In

IndoorSettings.h

– ioMapID

internal map

- (nonnull NSString *)ioMapID

Discussion

internal map

@return

Declared In

IndoorSettings.h

– IAFloorPlanID:

Internal Floor plan id for Indoor atlas

- (nullable NSString *)IAFloorPlanID:(int)ioFloor

Parameters

ioFloor

internal floor plan @return

Discussion

Internal Floor plan id for Indoor atlas

Declared In

IndoorSettings.h

– IAAPIapikey

Indoor atlas APi Key

- (nullable NSString *)IAAPIapikey

Return Value

key

Discussion

Indoor atlas APi Key

Declared In

IndoorSettings.h

– IAAPIapiSecret

Indoor atlas api key secret

- (nullable NSString *)IAAPIapiSecret

Return Value

secret

Discussion

Indoor atlas api key secret

Declared In

IndoorSettings.h

– virtualCoordinate:

Convert to virtual coordinate

- (CLLocationCoordinate2D)virtualCoordinate:(CGIndoorMapPoint)location

Parameters

location

gps coordinate @return

Discussion

Convert to virtual coordinate

Declared In

IndoorSettings.h

– geoCoordinateFromVirtual:

Convert to gps to virtual coordinate

- (CLLocationCoordinate2D)geoCoordinateFromVirtual:(CGIndoorMapPoint)location

Parameters

location

virtual coordinate @return

Discussion

Convert to gps to virtual coordinate

Declared In

IndoorSettings.h

– getMapFactor

Resizing facor

- (int)getMapFactor

Discussion

Resizing facor

@return

Declared In

IndoorSettings.h

– venueCategories

To get the categories data for venue

- (nonnull NSArray *)venueCategories

Return Value

An array of categories

Discussion

To get the categories data for venue

Declared In

IndoorSettings.h

– setStoreCount:

To set stores information

- (void)setStoreCount:(nonnull NSArray *)stores

Parameters

stores

An array of stores

Discussion

To set stores information

Declared In

IndoorSettings.h

– mapname

To get name of venue

- (nonnull NSString *)mapname

Return Value

Returns venue name

Discussion

To get name of venue

Declared In

IndoorSettings.h

– storeCategoryIcon:

To get category image name

- (nullable NSString *)storeCategoryIcon:(nonnull NSString *)storeid

Parameters

storeid

An ID of store

Return Value

Store category image name

Discussion

To get category image name

Declared In

IndoorSettings.h

– LevelInformation

To get levels information

- (nonnull NSArray *)LevelInformation

Return Value

An array of levels

Discussion

To get levels information

Declared In

IndoorSettings.h

– FloorListIDs

To get ID’s of the floors

- (nonnull NSArray *)FloorListIDs

Return Value

An array of loor ID’s

Discussion

To get ID’s of the floors

Declared In

IndoorSettings.h

– mapCenterPoint

To get map center coordinates with level

- (CGIndoorMapPoint)mapCenterPoint

Return Value

The center coordinates of map with level

Discussion

To get map center coordinates with level

Declared In

IndoorSettings.h

– mapInitialZoom

To get initial zoom loevel of map

- (float)mapInitialZoom

Return Value

THe initial zoom level

Discussion

To get initial zoom loevel of map

Declared In

IndoorSettings.h

– StoreLables

To get store labels data

- (nonnull NSArray *)StoreLables

Return Value

An array of store labels

Discussion

To get store labels data

Declared In

IndoorSettings.h

– SetStoreLables:

To set store labels

- (void)SetStoreLables:(nonnull NSArray *)listLables

Parameters

listLables

An array of stores

Discussion

To set store labels

Declared In

IndoorSettings.h

– MapboxFloorPlanID:

To get Mapbox floor id for floor

- (nonnull NSString *)MapboxFloorPlanID:(int)ioFloor

Parameters

ioFloor

floor number

Return Value

Mapbox floor ID

Discussion

To get Mapbox floor id for floor

Declared In

IndoorSettings.h

– MapboxFloorPlanID:forBuilding:

To get Mapbox floor id for floor

- (nonnull NSString *)MapboxFloorPlanID:(int)ioFloor forBuilding:(nonnull NSString *)buildingid

Parameters

ioFloor

floor number

buildingid

building number

Return Value

Mapbox floor ID

Discussion

To get Mapbox floor id for floor

Declared In

IndoorSettings.h

– MapboxMapToken

To fetch Mapbox token

- (nonnull NSString *)MapboxMapToken

Return Value

Mapbox token

Discussion

To fetch Mapbox token

Declared In

IndoorSettings.h

– getAreaBound

To get area bounds for venue

- (nonnull GMSCoordinateBounds *)getAreaBound

Return Value

area bounds

Discussion

To get area bounds for venue

Declared In

IndoorSettings.h

– getAreaRect

To get area bounds for venue

- (nonnull GMSPath *)getAreaRect

Return Value

area path

Discussion

To get area bounds for venue

Declared In

IndoorSettings.h

– maxMapZoom

To get maximum map zoom level

- (float)maxMapZoom

Return Value

zoom level

Discussion

To get maximum map zoom level

Declared In

IndoorSettings.h

– minMapZoom

To get minimaum map zoom level

- (float)minMapZoom

Return Value

zoom level

Discussion

To get minimaum map zoom level

Declared In

IndoorSettings.h

– BackToLeashDistance

TO get leash distance

- (int)BackToLeashDistance

Return Value

leash distance

Discussion

TO get leash distance

Declared In

IndoorSettings.h

– maxPathDiversion

The value of path diversion

- (int)maxPathDiversion

Return Value

path diversion

Discussion

The value of path diversion

Declared In

IndoorSettings.h

– extraSettings

Extra setting

- (nonnull NSDictionary *)extraSettings

Return Value

Dictionary of settings

Discussion

Extra setting

Declared In

IndoorSettings.h

– getBuildingAtUserLocation:

To get data of building according to user’s location

- (nonnull NSDictionary *)getBuildingAtUserLocation:(CGIndoorMapPoint)userLocation

Parameters

userLocation

user coordinates with floor

Return Value

a dictionary of building

Discussion

To get data of building according to user’s location

Declared In

IndoorSettings.h

– IAExternalFloorID:

To get external floor ID

- (int)IAExternalFloorID:(nonnull NSString *)ioFloor

Parameters

ioFloor

Floor number

Return Value

an External floor ID

Discussion

To get external floor ID

Declared In

IndoorSettings.h

– buildingList

To get data of building

- (nonnull NSArray *)buildingList

Return Value

An array of building

Discussion

To get data of building

Declared In

IndoorSettings.h

– useMapBoxMap

To

- (BOOL)useMapBoxMap

Return Value

BOOL value

Discussion

To

Declared In

IndoorSettings.h

– isLoadGoogleBasemap

Should display google map bellow indoormap or not

- (BOOL)isLoadGoogleBasemap

Return Value

true/false

Discussion

Should display google map bellow indoormap or not

Declared In

IndoorSettings.h

– showOutlineForLevel:onMap:

Display outline for floor

- (void)showOutlineForLevel:(int)levelCode onMap:(nonnull GMSMapView *)mapview

Parameters

levelCode

Level currently display

mapview

map view on which area draw

Discussion

Display outline for floor

Declared In

IndoorSettings.h

– initializeWithDefaultFloor

Capture Default Floor which indoor map to display

- (int)initializeWithDefaultFloor

Return Value

Level Nimber

Discussion

Capture Default Floor which indoor map to display

Declared In

IndoorSettings.h

– defaultLogoLocation

Logo location

- (nonnull NSString *)defaultLogoLocation

Return Value

Position topleft, topright, bottomleft, bottomright

Discussion

Logo location

Declared In

IndoorSettings.h

– getPromotionSnoozeTime

Promotion Snooze Time

- (int)getPromotionSnoozeTime

Return Value

time in minutes

Discussion

Promotion Snooze Time

Declared In

IndoorSettings.h

– getReRouteCoolDownTime

Re-Route CoolDown Time

- (int)getReRouteCoolDownTime

Return Value

Time in seconds

Discussion

Re-Route CoolDown Time

Declared In

IndoorSettings.h

– TileServerURL

URL From map image to be fetch

- (nonnull NSString *)TileServerURL

Return Value

Tile URL

Discussion

URL From map image to be fetch

Declared In

IndoorSettings.h

– shouldRotateMapWithHeading

Rotate map according true heading

- (BOOL)shouldRotateMapWithHeading

Return Value

True/False

Discussion

Rotate map according true heading

Declared In

IndoorSettings.h

– shouldRotateMapInitially

Rotate map to true north for user location

- (BOOL)shouldRotateMapInitially

Return Value

True/False

Discussion

Rotate map to true north for user location

Declared In

IndoorSettings.h

– applyFloorDetection

Use logic for floor Detection

- (BOOL)applyFloorDetection

Return Value

Yes/No

Discussion

Use logic for floor Detection

Declared In

IndoorSettings.h

– useInbuildMagneticsensorForHeading

Use Senser for Heading

- (BOOL)useInbuildMagneticsensorForHeading

Return Value

Yes/No

Discussion

Use Senser for Heading

Declared In

IndoorSettings.h

– getDestinationBuffer

Show Destination event reached

- (int)getDestinationBuffer

Return Value

X meters

Discussion

Show Destination event reached

Declared In

IndoorSettings.h

– textColorFromServer

Color of text on map

- (nonnull UIColor *)textColorFromServer

Return Value

color value

Discussion

Color of text on map

Declared In

IndoorSettings.h

– getWalkingSpeedPerMeter

Get Walking speed for venue

- (double)getWalkingSpeedPerMeter

Return Value

X minute/meters

Discussion

Get Walking speed for venue

Declared In

IndoorSettings.h

– mapInitialRotation

Get Map orientation

- (float)mapInitialRotation

Return Value

X angle againt north direction (in degree)

Discussion

Get Map orientation

Declared In

IndoorSettings.h

– mapInitialTilt

Get Map Tilt position

- (float)mapInitialTilt

Return Value

X tilt angle (in degree)

Discussion

Get Map Tilt position

Declared In

IndoorSettings.h

– useRerouteUsingBearing

Use Reroute by Heading

- (bool)useRerouteUsingBearing

Return Value

Yes/No

Discussion

Use Reroute by Heading

Declared In

IndoorSettings.h

– multiPointNavImage

Image For Multipoint POI Item

- (NSString *_Nullable)multiPointNavImage

Return Value

Image nameOnserver

Discussion

Image For Multipoint POI Item

Declared In

IndoorSettings.h

– mapFont

Return font family for map

- (NSString *_Nonnull)mapFont

Return Value

Font Font name on server

Discussion

Return font family for map

Declared In

IndoorSettings.h

– pathFormat

Return font family for map

- (PathFormatter *_Nonnull)pathFormat

Return Value

Font Font name on server

Discussion

Return font family for map

Declared In

IndoorSettings.h

– multiPointNavLimit

Number of items in searching Multiple waypoint

- (int)multiPointNavLimit

Return Value

no of count

Discussion

Number of items in searching Multiple waypoint

Declared In

IndoorSettings.h

– dynamicSplitPath

Path optimization at SDK End

- (float)dynamicSplitPath

Discussion

Path optimization at SDK End

Declared In

IndoorSettings.h

– shouldRotateMapWithPathSegment

map rotation while navigation mode

- (BOOL)shouldRotateMapWithPathSegment

Discussion

map rotation while navigation mode

Declared In

IndoorSettings.h

– enableAutoCenteringInNavMode

Center map in navigation Mode

- (BOOL)enableAutoCenteringInNavMode

Discussion

Center map in navigation Mode

Declared In

IndoorSettings.h

– show3DBuildings

Show Google map 3d buldings on map for external view

- (BOOL)show3DBuildings

Discussion

Show Google map 3d buldings on map for external view

Declared In

IndoorSettings.h

– getRouteTags

Listing all route option with given venue

- (NSArray<RouteTag*> *_Nonnull)getRouteTags

Discussion

Listing all route option with given venue

Declared In

IndoorSettings.h

– clearMemory

Cleanup IndoorMap setting from memory

- (void)clearMemory

Discussion

Cleanup IndoorMap setting from memory

Declared In

IndoorSettings.h