Plugin

sealed class Plugin

Class describing plugin instance.

For Mapbox plugins it is enough to provide plugin id from this class without plugin instance. For user-defined plugins both unique id and plugin instance must be provided.

Types

Companion
Link copied to clipboard
object Companion

Static ids for Mapbox plugins.

Custom
Link copied to clipboard
class Custom(id: String, instance: MapPlugin) : Plugin

Should be used to create custom user-defined plugins.

Mapbox
Link copied to clipboard
class Mapbox(id: String) : Plugin

Should be used to create Mapbox official plugins.

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Equals implementation taking only id into account.

hashCode
Link copied to clipboard
open override fun hashCode(): Int

Hash code implementation taking only id into account.

toString
Link copied to clipboard
open override fun toString(): String

toString implementation.

Properties

id
Link copied to clipboard
val id: String

Unique plugin id.

instance
Link copied to clipboard
val instance: MapPlugin?

Plugin instance implementing MapPlugin. Must be non-null for user-defined plugins or RuntimeException will occur when trying to initiate such plugin.

Inheritors

Plugin
Link copied to clipboard
Plugin
Link copied to clipboard