4.1. YSLD Quickstart¶

4.1.1.1. Property Syntax¶

Individual statements (or directives) in a YSLD styling document are designed as key-value, or property-value pairs of the following form:

<property>: <value>

The <property> is a string denoting the property name, while the <value> can be one of a number of different types depending on context.

4.1.1.2. Mappings and lists¶

There are three types of objects in a YSLD document:

1. Scalar, a simple value

2. Mapping, a collection of key-value (property-value) pairs

3. List, any collection of objects. A list can contain mappings, scalars, and even other lists.

   Lists require dashes for every entry, while mappings do not.

For example, a symbolizer block is a list, so every entry requires its own dash:

The polygon: and text: objects (the individual symbolizers themselves) are mappings, and as such, the contents do not require dashes, only indents:

- polygon:
    stroke-color: '#808080'
    fill-color: '#FF0000'

The dash next to polygon means that the item itself is contained in a list, not that it contains a list. And the placement of the dash is at the same level of indentation as the list title.

If you have a list that contains only one item, and there is no other content at higher levels of the list, you may omit the enclosing elements. For example, the following are equivalent:

feature-styles:
- rules:
  - symbolizers:
    - point:
        symbols:
        - mark:
            shape: circle
            fill-color: 'gray'

point:
  symbols:
  - mark:
      shape: circle
      fill-color: 'gray'

This is usefull for making your styles more concise.

4.1.1.3. Indentation¶

Indentation is very important in YSLD. All directives must be indented to its proper place to ensure proper hierarchy. Improper indentation will cause a style to be rendered incorrectly, or not at all.

For example, the polygon symbolizer, since it is a mapping, contains certain parameters inside it, such as the color of the fill and stroke. These must be indented such that they are “inside” the polygon block.

In this example, the following markup is correct:

- polygon:
    fill-color: '#808080'
    fill-opacity: 0.5
    stroke-color: black
    stroke-opacity: 0.75

The parameters inside the polygon (symbolizer) are indented, meaning that they are referencing the symbolizer and are not “outside it.”

Compare to the following incorrect markup:

- polygon:
  fill-color: '#808080'
  fill-opacity: 0.5
  stroke-color: black
  stroke-opacity: 0.75

4.1.1.4. Rules¶

We have already seen a CSS style composed of a single rule:

point:
  symbols:
  - mark:
      shape: circle
      fill-color: 'gray'

We can make a style consisting of more than one rule, carefully choosing the selector for each rule. In this case we are using a selector to style capital cities with a star, and non-capital with a circle:

rules:
  - filter: ${FEATURECLA = 'Admin-0 capital'}
    scale: [min, max]
    symbolizers:
    - point:
        size: 6
        symbols:
        - mark:
            shape: star
            stroke-color: 'black'
            stroke-width: 1
            fill-color: 'gray'
  - filter: ${FEATURECLA <> 'Admin-0 capital'}
    scale: [min, max]
    symbolizers:
    - point:
        size: 6
        symbols:
        - mark:
            shape: circle
            stroke-color: 'black'
            stroke-width: 1
            fill-color: 'gray'

The feature attribute test performed above uses Constraint Query Language (CQL). This syntax can be used to define filters to select content, similar to how the SQL WHERE statement is used. It can also be used to define expressions to access attribute values allowing their use when defining style properties.

Rule selectors can also be triggered based on the state of the rendering engine. In this example we are only applying labels when zoomed in:

rules:
  - scale: [min, '2.0E7']
    symbolizers:
    - text:
        label: ${NAME}
        fill-color: 'gray'

In the above example the label is defined using the CQL Expression NAME. This results in a dynamic style that generates each label on a case-by-case basis, filling in the label with the feature attribute NAME.

Reference:

• Filter Syntax (YSLD Reference)

• ECQL Reference (User Guide)

4.1.1.5. Variables¶

Up to this point we have been styling individual features, documenting how each shape is represented.

When styling multiple feaures, or using filters to style individual features in different yars, you may need to repeat styling information.

Variables in YSLD allow for a certain directive or block of directives to be defined by name and later reused. This can greatly simplify the styling document.

The two most-common use cases for using variables are:

• To create a more-friendly name for a value (such as using myorange instead of #EE8000)

• To define a block of directives to remove redundant content and to decrease file length

It is customary, but not required, to place all definitions at the very top of the YSLD file.

The syntax for defining a variable as a single value is:

define: &variable <value>

The defined variable can then be used as a value by variable name with a *:

<directive>: *variable

The syntax for defining a variable as a content block is:

define: &varblock
  <directive>: <value>
  <directive>: <value>
  ...
  <block>:
  - <directive>: <value>
    <directive>: <value>
  ...

The syntax for using a variable block is to prepend the variable name with <<: *. For example:

<block>:
- <directive>: <value>
  <<: *varblock

• Variables (YSLD Reference)

4.1.2.1. SLD Style¶

Here is an example SLD file for reference:

 1 <?xml version="1.0" encoding="ISO-8859-1"?>
 2 <StyledLayerDescriptor version="1.0.0"
 3  xsi:schemaLocation="http://www.opengis.net/sld StyledLayerDescriptor.xsd"
 4  xmlns="http://www.opengis.net/sld"
 5  xmlns:ogc="http://www.opengis.net/ogc"
 6  xmlns:xlink="http://www.w3.org/1999/xlink"
 7  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 8   <NamedLayer>
 9     <Name>airports</Name>
10     <UserStyle>
11       <Title>Airports</Title>
12       <FeatureTypeStyle>
13         <Rule>
14           <Name>airports</Name>
15           <Title>Airports</Title>
16           <PointSymbolizer>
17             <Graphic>
18               <ExternalGraphic>
19                 <OnlineResource xlink:type="simple"
20                 xlink:href="airport.svg" />
21                 <Format>image/svg</Format>
22               </ExternalGraphic>
23               <Size>16</Size>
24             </Graphic>
25           </PointSymbolizer>
26         </Rule>
27       </FeatureTypeStyle>
28     </UserStyle>
29   </NamedLayer>
30 </StyledLayerDescriptor>

4.1.2.2. YSLD Style¶

Here is the same example as YSLD:

 1 name: airports
 2 title: Airports
 3 scale: [min, max]
 4 symbolizers:
 5 - point:
 6     size: 16
 7     symbols:
 8     - external:
 9         url: airport.svg
10         format: image/svg

We use a point symbolizer to indicate we want this content drawn as a Point (line 16 in the SLD, line 5 in the YSLD). The point symbolizer declares an external graphic, which contains the URL airports.svg indicating the image that should be drawn (line 20 in the SLD, line 9 in the YSLD).

4.1.4.1. Explore Data¶

1. Return to the Data tab and use the Compute link to determine the minimum and maximum for the scalerank attribute.

4.1.4.2. Challenge Compare SLD Generation¶

# The rest API can be used to review your YAML file directly.

Browser:

• view-source:http://localhost:8080/geoserver/rest/styles/airport0.yaml

Command line:

curl -v -u admin:geoserver -XGET http://localhost:8080/geoserver/rest/styles/airports0.yaml

1. The REST API can also be used generate an SLD file:

   Browser:

   • view-source:http://localhost:8080/geoserver/rest/styles/airport0.sld?pretty=true

Command line:

curl -v -u admin:geoserver -XGET http://localhost:8080/geoserver/rest/styles/airports0.sld?pretty=true

1. Compare the generated SLD differ above with the hand written SLD file used as an example?

   Challenge: What differences can you spot?