ScaleBarSettingsInterface

Get current scalebar configuration.

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

Defines width of the border for the scale bar. Default value: 2.

Whether the scale is visible on the map. Default value: true.

Defines height of the scale bar. Default value: 2.

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. Default value: true.

Defines the margin to the bottom that the scale bar honors. Default value: 4.

Defines the margin to the left that the scale bar honors. Default value: 4.

Defines the margin to the right that the scale bar honors. Default value: 4.

Defines the margin to the top that the scale bar honors. Default value: 4.

Defines where the scale bar is positioned on the map Default value: "top-left".

Defines primary color of the scale bar. Default value: "black".

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

Configures minimum refresh interval, in millisecond, default is 15. Default value: 15.

Defines secondary color of the scale bar. Default value: "white".

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

Defines margin of the text bar of the scale bar. Default value: 8.

Defines text border width of the scale bar. Default value: 2.

Defines text color of the scale bar. Default value: "black".

Defines text size of the scale bar. Default value: 8.

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. Default value: false.