Classes
Type Definitions
-
Options{Object}
-
Properties:
Name Type Description classNamestring | undefined CSS class name. The default is
ol-scale-barwhen configured withbar: true. Otherwise the default isol-scale-line.minWidthnumber
(defaults to 64)Minimum width in pixels at the OGC default dpi. The width will be adjusted to match the dpi used.
maxWidthnumber | undefined Maximum width in pixels at the OGC default dpi. The width will be adjusted to match the dpi used.
renderfunction | undefined Function called when the control should be re-rendered. This is called in a
requestAnimationFramecallback.targetHTMLElement | string | undefined Specify a target if you want the control to be rendered outside of the map's viewport.
unitsUnits
(defaults to 'metric')Units.
barboolean
(defaults to false)Render scalebars instead of a line.
stepsnumber
(defaults to 4)Number of steps the scalebar should use. Use even numbers for best results. Only applies when
baristrue.textboolean
(defaults to false)Render the text scale above of the scalebar. Only applies when
baristrue.dpinumber | undefined dpi of output device such as printer. Only applies when
baristrue. If undefined the OGC default screen pixel size of 0.28mm will be assumed. -
Units{'degrees'} {'imperial'} {'nautical'} {'metric'} {'us'}
-
Units for the scale line.