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.

sealed class Plugin

Types

Companion
Link copied to clipboard

Static ids for Mapbox plugins.

object Companion
Custom
Link copied to clipboard

Should be used to create custom user-defined plugins.

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

Should be used to create Mapbox official plugins.

class Mapbox(id: String) : Plugin

Functions

equals
Link copied to clipboard

Equals implementation taking only id into account.

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

Hash code implementation taking only id into account.

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

toString implementation.

open override fun toString(): String

Properties

id
Link copied to clipboard

Unique plugin id.

val id: String
instance
Link copied to clipboard

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

val instance: MapPlugin?

Inheritors

Plugin
Link copied to clipboard
Plugin
Link copied to clipboard