ScaleBarSettingsInterface

Interface that defines the public settings interface for ScaleBarPlugin.

interface ScaleBarSettingsInterface

Functions

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

Get current scalebar configuration.

abstract fun getSettings(): ScaleBarSettings
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String
updateSettings
Link copied to clipboard

Update scalebar configuration, the update will be applied to the plugin automatically.

abstract fun updateSettings(block: ScaleBarSettings.() -> Unit)

Properties

borderWidth
Link copied to clipboard

Defines width of the border for the scale bar.

abstract var borderWidth: Float
enabled
Link copied to clipboard

Whether the scale is visible on the map.

abstract var enabled: Boolean
height
Link copied to clipboard

Defines height of the scale bar.

abstract var height: Float
isMetricUnits
Link copied to clipboard

Whether the scale bar is using metric unit. True if the scale bar is using metric system, false if the scale bar is using imperial units.

abstract var isMetricUnits: Boolean
marginBottom
Link copied to clipboard

Defines the margin to the bottom that the scale bar honors.

abstract var marginBottom: Float
marginLeft
Link copied to clipboard

Defines the margin to the left that the scale bar honors.

abstract var marginLeft: Float
marginRight
Link copied to clipboard

Defines the margin to the right that the scale bar honors.

abstract var marginRight: Float
marginTop
Link copied to clipboard

Defines the margin to the top that the scale bar honors.

abstract var marginTop: Float
position
Link copied to clipboard

Defines where the scale bar is positioned on the map

abstract var position: Int
primaryColor
Link copied to clipboard

Defines primary color of the scale bar.

abstract var primaryColor: Int
ratio
Link copied to clipboard

configures ratio of scale bar max width compared with MapView width, default is 0.5.

abstract var ratio: Float
refreshInterval
Link copied to clipboard

Configures minimum refresh interval, in millisecond, default is 15.

abstract var refreshInterval: Long
secondaryColor
Link copied to clipboard

Defines secondary color of the scale bar.

abstract var secondaryColor: Int
showTextBorder
Link copied to clipboard

Configures whether to show the text border or not, default is true.

abstract var showTextBorder: Boolean
textBarMargin
Link copied to clipboard

Defines margin of the text bar of the scale bar.

abstract var textBarMargin: Float
textBorderWidth
Link copied to clipboard

Defines text border width of the scale bar.

abstract var textBorderWidth: Float
textColor
Link copied to clipboard

Defines text color of the scale bar.

abstract var textColor: Int
textSize
Link copied to clipboard

Defines text size of the scale bar.

abstract var textSize: Float

Inheritors

ScaleBarPlugin
Link copied to clipboard
ScaleBarSettingsBase
Link copied to clipboard