ScaleBarSettings class

Shows the scale bar on the map.

Constructors

ScaleBarSettings({bool? enabled, OrnamentPosition? position, double? marginLeft, double? marginTop, double? marginRight, double? marginBottom, int? textColor, int? primaryColor, int? secondaryColor, double? borderWidth, double? height, double? textBarMargin, double? textBorderWidth, double? textSize, bool? isMetricUnits, int? refreshInterval, bool? showTextBorder, double? ratio, bool? useContinuousRendering})

Properties

borderWidth ↔ double?

Defines width of the border for the scale bar. This property is specified in pixels.

getter/setter pair

enabled ↔ bool?

Whether the scale is visible on the map.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

height ↔ double?

Defines height of the scale bar. This property is specified in pixels.

getter/setter pair

isMetricUnits ↔ bool?

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.

getter/setter pair

marginBottom ↔ double?

Defines the margin to the bottom that the scale bar honors. This property is specified in pixels.

getter/setter pair

marginLeft ↔ double?

Defines the margin to the left that the scale bar honors. This property is specified in pixels.

getter/setter pair

marginRight ↔ double?

Defines the margin to the right that the scale bar honors. This property is specified in pixels.

getter/setter pair

marginTop ↔ double?

Defines the margin to the top that the scale bar honors. This property is specified in pixels.

getter/setter pair

position ↔ OrnamentPosition?

Defines where the scale bar is positioned on the map

getter/setter pair

primaryColor ↔ int?

Defines primary color of the scale bar.

getter/setter pair

ratio ↔ double?

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

getter/setter pair

refreshInterval ↔ int?

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

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secondaryColor ↔ int?

Defines secondary color of the scale bar.

getter/setter pair

showTextBorder ↔ bool?

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

getter/setter pair

textBarMargin ↔ double?

Defines margin of the text bar of the scale bar. This property is specified in pixels.

getter/setter pair

textBorderWidth ↔ double?

Defines text border width of the scale bar. This property is specified in pixels.

getter/setter pair

textColor ↔ int?

Defines text color of the scale bar.

getter/setter pair

textSize ↔ double?

Defines text size of the scale bar. This property is specified in pixels.

getter/setter pair

useContinuousRendering ↔ bool?

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.

getter/setter pair

Methods

encode() → Object

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

decode(Object result) → ScaleBarSettings