Package org.geotools.styling

Interface PolygonSymbolizer

  • All Superinterfaces:
    PolygonSymbolizer, Symbolizer, Symbolizer
    All Known Implementing Classes:
    PolygonSymbolizerImpl
    public interface PolygonSymbolizer
extends PolygonSymbolizer, Symbolizer
    A symbolizer describes how a polygon feature should appear on a map.

    The symbolizer describes not just the shape that should appear but also such graphical properties as color and opacity.

    A symbolizer is obtained by specifying one of a small number of different types of symbolizer and then supplying parameters to overide its default behaviour.

    The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.: 

    
 <xsd:element name="PolygonSymbolizer" substitutionGroup="sld:Symbolizer">
    <xsd:annotation>
      <xsd:documentation>
        A "PolygonSymbolizer" specifies the rendering of a polygon or
        area geometry, including its interior fill and border stroke.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:complexType>
      <xsd:complexContent>
       <xsd:extension base="sld:SymbolizerType">
         <xsd:sequence>
           <xsd:element ref="sld:Geometry" minOccurs="0"/>
           <xsd:element ref="sld:Fill" minOccurs="0"/>
           <xsd:element ref="sld:Stroke" minOccurs="0"/>
         </xsd:sequence>
       </xsd:extension>
     </xsd:complexContent>
   </xsd:complexType>
 </xsd:element>

    Renderers can use this information when displaying styled features, though it must be remembered that not all renderers will be able to fully represent strokes as set out by this interface. For example, opacity may not be supported.

    Notes:

    • The graphical parameters and their values are derived from SVG/CSS2 standards with names and semantics which are as close as possible.
    Author:
    James Macgill

    • Field Detail

      • GRAPHIC_MARGIN_KEY

        static final String GRAPHIC_MARGIN_KEY
        Pixels between each graphic of a polygon fill
        See Also:
        Constant Field Values

    • Method Detail

      • getFill

        Fill getFill()
        Provides the graphical-symbolization parameter to use to fill the area of the geometry. Note that the area should be filled first before the outline is rendered.
        Specified by:
        getFill in interface PolygonSymbolizer
        Returns:
        The Fill style to use when rendering the area.

      • setFill

        void setFill​(Fill fill)
        Provides the graphical-symbolization parameter to use to fill the area of the geometry. Note that the area should be filled first before the outline is rendered.
        Parameters:
        fill - The Fill style to use when rendering the area.

      • getStroke

        Stroke getStroke()
        Provides the graphical-symbolization parameter to use for the outline of the Polygon.
        Specified by:
        getStroke in interface PolygonSymbolizer
        Returns:
        The Stroke style to use when rendering lines.

      • setStroke

        void setStroke​(Stroke stroke)
        Provides the graphical-symbolization parameter to use for the outline of the Polygon.
        Parameters:
        stroke - The Stroke style to use when rendering lines.

      • setPerpendicularOffset

        void setPerpendicularOffset​(Expression offset)
        PerpendicularOffset works as defined for LineSymbolizer, allowing to draw polygons smaller or larger than their actual geometry.
        Parameters:
        offset - Offset from the edge polygon positive outside; negative to the inside with a default of 0.

      • getDisplacement

        Displacement getDisplacement()
        Displacement from the original geometry in pixels.
        Specified by:
        getDisplacement in interface PolygonSymbolizer
        Returns:
        Displacement above and to the right of the indicated point; default x=0, y=0

      • setDisplacement

        void setDisplacement​(Displacement displacement)
        Provide x / y offset in pixels used to crate shadows.