stroke.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .. list-table::
  2. :class: non-responsive
  3. :header-rows: 1
  4. :stub-columns: 1
  5. :widths: 20 10 50 20
  6. * - Property
  7. - Required?
  8. - Description
  9. - Default value
  10. * - ``stroke-color``
  11. - No
  12. - Color of line features.
  13. - ``'#000000'`` (black)
  14. * - ``stroke-width``
  15. - No
  16. - Width of line features, measured in pixels.
  17. - ``1``
  18. * - ``stroke-opacity``
  19. - No
  20. - Opacity of line features. Valid values are a decimal value between ``0`` (completely transparent) and ``1`` (completely opaque).
  21. - ``1``
  22. * - ``stroke-linejoin``
  23. - No
  24. - How line segments are joined together. Options are ``mitre`` (sharp corner), ``round`` (round corner), and ``bevel`` (diagonal corner).
  25. - ``mitre``
  26. * - ``stroke-linecap``
  27. - No
  28. - How line features are rendered at their ends. Options are ``butt`` (sharp square edge), ``round`` (rounded edge), and ``square`` (slightly elongated square edge).
  29. - ``butt``
  30. * - ``stroke-dasharray``
  31. - No
  32. - A numeric list signifying length of lines and gaps, creating a dashed effect. Units are pixels, so ``"2 3"`` would be a repeating pattern of 2 pixels of drawn line followed by 3 pixels of blank space. If only one number is supplied, this will mean equal amounts of line and gap.
  33. - No dash
  34. * - ``stroke-dashoffset``
  35. - No
  36. - Number of pixels into the dasharray to offset the drawing of the dash, used to shift the location of the lines and gaps in a dash.
  37. - ``0``
  38. * - ``stroke-graphic``
  39. - No
  40. - A design or pattern to be used along the stroke. Output will always be a linear repeating pattern, and as such is not tied to the value of ``stroke-width``. Can either be a mark consisting of a common shape or a URL that points to a graphic. The ``<graphic_options>`` should consist of a mapping containing ``symbols:`` followed by an ``external:`` or ``mark:``, with appropriate parameters as detailed in the :ref:`ysld_reference_symbolizers_point` section. Cannot be used with ``stroke-graphic-fill``.
  41. - N/A
  42. * - ``stroke-graphic-fill``
  43. - No
  44. - A design or pattern to be used for the fill of the stroke. The area that is to be filled is tied directly to the value of ``stroke-width``. Can either be a mark consisting of a common shape or a URL that points to a graphic. The ``<graphic_options>`` should consist of a mapping containing ``symbols:`` followed by an ``external:`` or ``mark:``, with appropriate parameters as detailed in the :ref:`ysld_reference_symbolizers_point` section. Cannot be used with ``stroke-graphic``.
  45. - N/A