Lines¶

Code¶

Download the "Simple line" YSLD

1 title: 'YSLD Cook Book: Simple Line'
2 feature-styles:
3 - name: name
4   rules:
5   - symbolizers:
6     - line:
7         stroke-color: '#000000'
8         stroke-width: 3

Details¶

There is one rule in one feature style for this YSLD, which is the simplest possible situation. (All subsequent examples will contain one rule and one feature style unless otherwise specified.) Styling lines is accomplished via the line symbolizer (lines 5-8). Line 7 specifies the color of the line to be black ('#000000'), while line 8 specifies the width of the lines to be 3 pixels.

Code¶

Download the "Line with border" YSLD

 1 title: 'YSLD Cook Book: Line with border'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - symbolizers:
 6     - line:
 7         stroke-color: '#333333'
 8         stroke-width: 5
 9         stroke-linecap: round
10 - name: name
11   rules:
12   - symbolizers:
13     - line:
14         stroke-color: '#6699FF'
15         stroke-width: 3
16         stroke-linecap: round

Details¶

Lines in YSLD have no notion of a “fill”, only “stroke”. Thus, unlike points or polygons, it is not possible to style the “edge” of the line geometry. It is, however, possible to achieve this effect by drawing each line twice: once with a certain width and again with a slightly smaller width. This gives the illusion of fill and stroke by obscuring the larger lines everywhere except along the edges of the smaller lines.

Since every line is drawn twice, the order of the rendering is very important. GeoServer renders feature-styles in the order that they are presented in the YSLD. In this style, the gray border lines are drawn first via the first feature style, followed by the blue center lines in a second feature style. This ensures that the blue lines are not obscured by the gray lines, and also ensures proper rendering at intersections, so that the blue lines “connect”.

In this example, lines 3-9 comprise the first feature style, which is the outer line (or “stroke”). Line 7 specifies the color of the line to be dark gray ('#333333'), line 8 specifies the width of this line to be 5 pixels, and in line 9 a stroke-linecap parameter of round renders the ends of the line as rounded instead of flat. (When working with bordered lines using a round line cap ensures that the border connects properly at the ends of the lines.)

Lines 10-16 comprise the second feature-style, which is the the inner line (or “fill”). Line 14 specifies the color of the line to be a medium blue ('#6699FF'), line 15 specifies the width of this line to be 3 pixels, and line 16 again renders the edges of the line to be rounded instead of flat.

The result is a 3 pixel blue line with a 1 pixel gray border, since the 5 pixel gray line will display 1 pixel on each side of the 3 pixel blue line.

Code¶

Download the "Dashed line" YSLD

1 title: 'YSLD Cook Book: Dashed line'
2 feature-styles:
3 - name: name
4   rules:
5   - symbolizers:
6     - line:
7         stroke-color: '#0000FF'
8         stroke-width: 3
9         stroke-dasharray: 5 2

Details¶

In this example, line 8 sets the color of the lines to be blue ('#0000FF') and line 8 sets the width of the lines to be 3 pixels. Line 9 determines the composition of the line dashes. The value of 5 2 creates a repeating pattern of 5 pixels of drawn line, followed by 2 pixels of omitted line.

Code¶

Download the "Offset line" YSLD

 1 title: 'YSLD Cook Book: Dashed line'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - symbolizers:
 6     - line:
 7         stroke-color: '#000000'
 8         stroke-width: 2
 9     - line:
10         stroke-color: '#0000FF'
11         stroke-width: 3
12         stroke-dasharray: 5 2
13         offset: 3

Details¶

In this example, lines 6-8 draw a simple black line like in the Simple line example. Lines 9-12 draw a blue dashed line like in the above Dashed line example. Line 13 modifies the dashed line with a 3 pixel offset from the line geometry.

Code¶

Download the "Railroad (hatching)" YSLD

 1 title: 'YSLD Cook Book: Railroad (hatching)'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - symbolizers:
 6     - line:
 7         stroke-color: '#333333'
 8         stroke-width: 3
 9     - line:
10         stroke-color: '#333333'
11         stroke-width: 1
12         stroke-graphic-stroke:
13           size: 12
14           symbols:
15           - mark:
16               shape: shape://vertline
17               stroke-color: '#333333'
18               stroke-width: 1

Details¶

In this example there are two line symbolizers. The first symbolizer, on lines 6-8, draws a standard line, with line 7 drawing the lines as dark gray ('#333333') and line 8 setting the width of the lines to be 2 pixels.

The hatching is invoked in the second symbolizer, on lines 9-18. Line 16 specifies that the symbolizer draw a vertical line hatch (shape://vertline) perpendicular to the line geometry. Lines 17-18 set the hatch color to dark gray ('#333333') and width to 1 pixel. Finally, line 13 specifies both the length of the hatch and the distance between each hatch to both be 12 pixels.

Code¶

Download the "Spaced symbols" YSLD

 1 name: Default Styler
 2 title: 'YSLD Cook Book: Dash/Space line'
 3 feature-styles:
 4 - name: name
 5   rules:
 6   - symbolizers:
 7     - line:
 8         stroke-color: '#333333'
 9         stroke-width: 1
10         stroke-dasharray: 4 6
11         stroke-graphic-stroke:
12           size: 4
13           symbols:
14           - mark:
15               shape: circle
16               stroke-color: '#333333'
17               stroke-width: 1
18               fill-color: '#666666'

Details¶

This example, like others before, uses a stroke-graphic-stroke to place a graphic symbol along a line. The symbol, defined on lines 14-18 is a 4 pixel gray circle with a dark gray outline. The spacing between symbols is controlled with the stroke-dasharray at line 9, which specifies 4 pixels of pen-down (just enough to draw the circle) and 6 pixels of pen-up, to provide the spacing.

Code¶

Download the "Spaced symbols" YSLD

 1 title: 'YSLD Cook Book: Dash/Symbol line'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - symbolizers:
 6     - line:
 7         stroke-color: '#0000FF'
 8         stroke-width: 1
 9         stroke-dasharray: 10 10
10     - line:
11         stroke-color: '#000033'
12         stroke-width: 1
13         stroke-dasharray: 5 15
14         stroke-dashoffset: 7.5
15         stroke-graphic-stroke:
16           size: 5
17           symbols:
18           - mark:
19               shape: circle
20               stroke-color: '#000033'
21               stroke-width: 1

Details¶

In this example two line symbolizers use stroke-dasharray and different symbology to produce a sequence of alternating dashes and symbols. The first symbolizer (lines 6-9) is a simple dashed line alternating 10 pixels of pen-down with 10 pixels of pen-up. The second symbolizer (lines 10-21) alternates a 5 pixel empty circle with 15 pixels of white space. The circle symbol is produced by a mark element, with its symbology specified by stroke parameters (lines 20-21). The spacing between symbols is controlled with the stroke-dasharray (line 13), which specifies 5 pixels of pen-down (just enough to draw the circle) and 15 pixels of pen-up. In order to have the two sequences positioned correctly the second one uses a stroke-dashoffset of 7.5 (line 14). This makes the sequence start with 12.5 pixels of white space, then a circle (which is then centered between the two line segments of the other pattern), then 15 pixels of white space, and so on.

Code¶

Download the "Line with default label" YSLD

 1 name: Default Styler
 2 title: 'YSLD Cook Book: Line with default label'
 3 feature-styles:
 4 - name: name
 5   rules:
 6   - symbolizers:
 7     - line:
 8         stroke-color: '#FF0000'
 9         stroke-width: 1
10     - text:
11         label: ${name}
12         fill-color: '#000000'
13         font-family: Serif
14         font-size: 10
15         font-style: normal
16         font-weight: normal
17         placement: point

Details¶

In this example, there is one rule with a line symbolizer and a text symbolizer. The line symbolizer (lines 6-8) draws red lines ('#FF0000'). The text symbolizer (lines 10-17) determines the labeling of the lines. Line 10 specifies that the text of the label will be determined by the value of the “name” attribute for each line. (Refer to the attribute table in the Example lines layer section if necessary.) Line 11 sets the text color to black. All other details about the label are set to the renderer default, which here is Times New Roman font, font color black, and font size of 10 pixels.

Code¶

Download the "Label following line" YSLD

 1 title: 'YSLD Cook Book: Label following line'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - symbolizers:
 6     - line:
 7         stroke-color: '#FF0000'
 8         stroke-width: 1
 9     - text:
10         label: ${name}
11         fill-color: '#000000'
12         placement: line
13         offset: 0
14         x-followLine: true

Details¶

As the Alternating symbols with dash offsets example showed, the default label behavior isn’t optimal. The label is displayed at a tangent to the line itself, leading to uncertainty as to which label corresponds to which line.

This example is similar to the Alternating symbols with dash offsets example with the exception of lines 12-14. Line 14 sets the option to have the label follow the line, while lines 12-13 specify that the label is placed along a line. If placement: line is not specified in an YSLD, then placement: point is assumed, which isn’t compatible with line-specific rendering options.

Code¶

Download the "Optimized label" YSLD

 1 title: 'YSLD Cook Book: Optimized label placement'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - symbolizers:
 6     - line:
 7         stroke-color: '#FF0000'
 8         stroke-width: 1
 9     - text:
10         label: ${name}
11         fill-color: '#000000'
12         placement: line
13         offset: 0
14         x-followLine: true
15         x-maxAngleDelta: 90
16         x-maxDisplacement: 400
17         x-repeat: 150

Details¶

GeoServer uses “conflict resolution” to ensure that labels aren’t drawn on top of other labels, obscuring them both. This accounts for the reason why many lines don’t have labels in the previous example, Label following line. While this setting can be toggled, it is usually a good idea to leave it on and use other label placement options to ensure that labels are drawn as often as desired and in the correct places. This example does just that.

This example is similar to the previous example, Label following line. The only differences are contained in lines 15-17. Line 15 sets the maximum angle that the label will follow. This sets the label to never bend more than 90 degrees to prevent the label from becoming illegible due to a pronounced curve or angle. Line 16 sets the maximum displacement of the label to be 400 pixels. In order to resolve conflicts with overlapping labels, GeoServer will attempt to move the labels such that they are no longer overlapping. This value sets how far the label can be moved relative to its original placement. Finally, line 17 sets the labels to be repeated every 150 pixels. A feature will typically receive only one label, but this can cause confusion for long lines. Setting the label to repeat ensures that the line is always labeled locally.

Code¶

Download the "Optimized and styled label" YSLD

 1 title: 'YSLD Cook Book: Optimized and styled label'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - symbolizers:
 6     - line:
 7         stroke-color: '#FF0000'
 8         stroke-width: 1
 9     - text:
10         label: ${name}
11         fill-color: '#000000'
12         font-family: Arial
13         font-size: 10
14         font-style: normal
15         font-weight: bold
16         placement: line
17         offset: 0
18         x-followLine: true
19         x-maxAngleDelta: 90
20         x-maxDisplacement: 400
21         x-repeat: 150

Details¶

This example is similar to the Optimized label placement. The only difference is in the font information, which is contained in lines 12-15. Line 12 sets the font family to be “Arial”, line 13 sets the font size to 10, line 14 sets the font style to “normal” (as opposed to “italic” or “oblique”), and line 15 sets the font weight to “bold” (as opposed to “normal”).

Code¶

Download the "Attribute-based line" YSLD

 1 title: 'YSLD Cook Book: Attribute-based line'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - name: local-road
 6     filter: ${type = 'local-road'}
 7     symbolizers:
 8     - line:
 9         stroke-color: '#009933'
10         stroke-width: 2
11 - name: name
12   rules:
13   - name: secondary
14     filter: ${type = 'secondary'}
15     symbolizers:
16     - line:
17         stroke-color: '#0055CC'
18         stroke-width: 3
19 - name: name
20   rules:
21   - name: highway
22     filter: ${type = 'highway'}
23     symbolizers:
24     - line:
25         stroke-color: '#FF0000'
26         stroke-width: 6

Details¶

There are three types of road classes in our fictional country, ranging from back roads to high-speed freeways: “highway”, “secondary”, and “local-road”. In order to handle each case separately, there is more than one feature style, each containing a single rule. This ensures that each road type is rendered in order, as each feature style is drawn based on the order in which it appears in the YSLD.

The three rules are designed as follows:

Lines 3-10 comprise the first rule. Line 6 sets the filter for this rule, such that the “type” attribute has a value of “local-road”. If this condition is true for a particular line, the rule is rendered according to the line symbolizer which is on lines 8-10. Lines 9-10 set the color of the line to be a dark green ('#009933') and the width to be 2 pixels.

Lines 11-18 comprise the second rule. Line 14 sets the filter for this rule, such that the “type” attribute has a value of “secondary”. If this condition is true for a particular line, the rule is rendered according to the line symbolizer which is on lines 16-18. Lines 17-18 set the color of the line to be a dark blue ('#0055CC') and the width to be 3 pixels, making the lines slightly thicker than the “local-road” lines and also a different color.

Lines 19-26 comprise the third and final rule. Line 22 sets the filter for this rule, such that the “type” attribute has a value of “primary”. If this condition is true for a particular line, the rule is rendered according to the line symbolizer which is on lines 24-26. Lines 25-26 set the color of the line to be a bright red ('#FF0000') and the width to be 6 pixels, so that these lines are rendered on top of and thicker than the other two road classes. In this way, the “primary” roads are given priority in the map rendering.

Code¶

Download the "Zoom-based line" YSLD

 1 title: 'YSLD Cook Book: Zoom-based line'
 2 feature-styles:
 3 - name: name
 4   rules:
 5   - name: Large
 6     scale: [min,1.8e8]
 7     symbolizers:
 8     - line:
 9         stroke-color: '#009933'
10         stroke-width: 6
11   - name: Medium
12     scale: [1.8e8,3.6e8]
13     symbolizers:
14     - line:
15         stroke-color: '#009933'
16         stroke-width: 4
17   - name: Small
18     scale: [3.6e8,max]
19     symbolizers:
20     - line:
21         stroke-color: '#009933'
22         stroke-width: 2

Details¶

It is often desirable to make shapes larger at higher zoom levels when creating a natural-looking map. This example varies the thickness of the lines according to the zoom level (or more accurately, scale denominator). Scale denominators refer to the scale of the map. A scale denominator of 10,000 means the map has a scale of 1:10,000 in the units of the map projection.

This style contains three rules. The three rules are designed as follows:

The order of these rules does not matter since the scales denominated in each rule do not overlap.

The first rule (lines 5-10) is the smallest scale denominator, corresponding to when the view is “zoomed in”. The scale rule is set on line 6, so that the rule will apply to any map with a scale denominator of 180,000,000 or less. Lines 9-10 draw the line to be dark green ('#009933') with a width of 6 pixels.

The second rule (lines 11-16) is the intermediate scale denominator, corresponding to when the view is “partially zoomed”. Lines 12 set the scale such that the rule will apply to any map with scale denominators between 180,000,000 and 360,000,000. (The lower bound is inclusive and the upper bound is exclusive, so a zoom level of exactly 360,000,000 would not apply here.) Aside from the scale, the only difference between this rule and the previous is the width of the lines, which is set to 4 pixels on line 16.

The third rule (lines 17-22) is the largest scale denominator, corresponding to when the map is “zoomed out”. The scale rule is set on line 18, so that the rule will apply to any map with a scale denominator of 360,000,000 or greater. Again, the only other difference between this rule and the others is the width of the lines, which is set to 2 pixels on line 22.

The result of this style is that lines are drawn with larger widths as one zooms in and smaller widths as one zooms out.