profi-sdk-aos-model/com.sygic.profi.model.pm.poi/PMPoiCategory

PMPoiCategory

data class PMPoiCategory(val id: String, val color: String? = null, val icon: String? = null, val zoomLevel: Float = 0.0f, val priority: Int = 0, val importance: PMPoiCategoryImportance, val showWithoutText: Boolean = false, val parentId: String? = null, val displayName: List<PMPoiCategoryDisplayName>? = emptyList(), val searchPriority: Int = 0)

POI Category

Constructors

PMPoiCategory

fun PMPoiCategory(id: String, color: String? = null, icon: String? = null, zoomLevel: Float = 0.0f, priority: Int = 0, importance: PMPoiCategoryImportance, showWithoutText: Boolean = false, parentId: String? = null, displayName: List<PMPoiCategoryDisplayName>? = emptyList(), searchPriority: Int = 0)

Properties

color

val color: String? = null

RGBA hex color for mark on map, default value is 0x00000000 - black transparent

displayName

val displayName: List<PMPoiCategoryDisplayName>?

A set of display names (human readable texts), in various languages, for the Place. Intended for user interaction. Navigation displays only "title"
on the map. "subtitle" is only returned in the response for the search result.

icon

val icon: String? = null

Character code for icon. Default: empty string.

val id: String

Unique, integrator maintained category identifier.

importance

val importance: PMPoiCategoryImportance

Importance of poi-category to be shown on the map
Default value is PMPoiCategoryImportance.Disabled

parentId

val parentId: String? = null

Parameter parentId represents id of the parent Category(POI group). Only one level of hierarchy is allowed. This category will inherit the parents
parameters and it can override them by specifying it. Only categories which have defined parentId are displayed on map.
To create only parent Category the parentId is not filled out.

priority

val priority: Int = 0

Drawing priority at same zoom, all integer range is possible to use.
If there are two points and both of then should be drawn on the map (because of zoomLevel), then only point with higher priority will be shown.
If there are two points and both of then should be drawn on the map (because of zoomLevel), and that both of them has the same priority, then importance is significant.

searchPriority

val searchPriority: Int = 0

Search priority of the Category, relative to other categories. Minimum value is 1, maximum is 15

showWithoutText

val showWithoutText: Boolean = false

If set to true the Place is drawn without it's 'displayName'. Default: false

zoomLevel

val zoomLevel: Float = 0.0f

Minimum zoom level at which Places with this category will be drawn on map. The larger the value the closer to the ground. Range: 0.0-20.0. Default: 0.0.
If there is map view with zoom less than this value, then this category will not be shown on map.
If there is map view with zoom higher than this value, then this category will be shown on map with attributes importance and priority