ScaleBar.MaxLengthPixels Property
Gets or sets the maximal length of the scale bar graphic, in pixels, excluding labels and background.
Syntax
public System.Double MaxLengthPixels { get; set; }Property Value
Default: 300.0
The maximal length of the scale bar graphic, in pixels, excluding labels and background.
Remarks
The length of one scale bar division, measured in length units, must be a round number like 10, 20 or 50 km (see also ScaleBarDivisions). Therefore, the length of the scale bar graphic, in pixels, must vary with the map scale. The amount of variation depends on the Divisions setting:
Divisions | Possible scale bar length (percentages of the maximum) |
|---|---|
One | 40 – 100% |
Few | 67 – 100% |
Several | 67 – 100% |
If the MaxLengthPixels is too short when the scale bar has more than one division, there may not be enough room for all numeric labels. Instead of showing crowded labels, the visualization will suppress the interior labels and just keep the first and the last, but it would usually be better if you can increase the MaxLengthPixels. Recommended minimum values for the default font are given below; the default font is Arial 14pt, so if you are using Arial 21pt instead, you should multiply the values by 1.5.
Divisions | MaxLengthPixels should be at least |
|---|---|
One | 160 pixels |
Few | 200 pixels |
Several | 290 pixels |
When there is one division, there will be only one numeric label so it cannot overlap any other, but the recommendation assumes that the single number is followed by an abbreviated unit label like "NM" and that these two labels are placed centered horizontally above or below the scale bar, where they should fit between the two end points of the scale bar graphic.
Apart from the value of MaxLengthPixels, there is a built-in constraint that the scale bar element, including its background rectangle, will not become longer than about half the width of the map window. This ensures that the scale bar will fit inside the map window even if the window is resized to become narrow. (The constraint uses half the map window width since that should be enough for a scale bar, and since there could be another screen element in the opposite corner.)
Platforms
Windows, Linux, Android