ScaleBarSettingsBase

Abstract settings class for ScaleBarPlugin.

This abstract class exposes all the required public APIs to configure the ScaleBarPlugin.

abstract class ScaleBarSettingsBase : ScaleBarSettingsInterface

Constructors

ScaleBarSettingsBase
Link copied to clipboard
fun ScaleBarSettingsBase()

Functions

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

Get current scalebar configuration.

open override 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.

open override fun updateSettings(block: ScaleBarSettings.() -> Unit)

Properties

borderWidth
Link copied to clipboard

Defines width of the border for the scale bar.

open override var borderWidth: Float
enabled
Link copied to clipboard

Whether the scale is visible on the map.

open override var enabled: Boolean
height
Link copied to clipboard

Defines height of the scale bar.

open override 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.

open override var isMetricUnits: Boolean
marginBottom
Link copied to clipboard

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

open override var marginBottom: Float
marginLeft
Link copied to clipboard

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

open override var marginLeft: Float
marginRight
Link copied to clipboard

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

open override var marginRight: Float
marginTop
Link copied to clipboard

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

open override var marginTop: Float
position
Link copied to clipboard

Defines where the scale bar is positioned on the map

open override var position: Int
primaryColor
Link copied to clipboard

Defines primary color of the scale bar.

open override var primaryColor: Int
ratio
Link copied to clipboard

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

open override var ratio: Float
refreshInterval
Link copied to clipboard

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

open override var refreshInterval: Long
secondaryColor
Link copied to clipboard

Defines secondary color of the scale bar.

open override var secondaryColor: Int
showTextBorder
Link copied to clipboard

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

open override var showTextBorder: Boolean
textBarMargin
Link copied to clipboard

Defines margin of the text bar of the scale bar.

open override var textBarMargin: Float
textBorderWidth
Link copied to clipboard

Defines text border width of the scale bar.

open override var textBorderWidth: Float
textColor
Link copied to clipboard

Defines text color of the scale bar.

open override var textColor: Int
textSize
Link copied to clipboard

Defines text size of the scale bar.

open override var textSize: Float
useContinuousRendering
Link copied to clipboard

If set to True scale bar will be triggering onDraw depending on ScaleBarSettings.refreshInterval even if actual data did not change. If set to False scale bar will redraw only on demand. Defaults to False and should not be changed explicitly in most cases. Could be set to True to produce correct GPU frame metrics when running gfxinfo command.

open override var useContinuousRendering: Boolean

Inheritors

ScaleBarPluginImpl
Link copied to clipboard