Ticket #2292 (closed defect: fixed)

Opened 7 years ago

Last modified 7 years ago

Update docs for LABEL PRIORITY

Reported by: dmorissette Owned by: dmorissette
Priority: normal Milestone: 5.0 release
Component: Documentation - MapServer Version: svn-trunk (development)
Severity: normal Keywords:
Cc:

Description (last modified by dmorissette) (diff)

This ticket is to track docs updates for the new LABEL PRIORITY feature added in ticket #1619.

See also RFC 27:  http://mapserver.gis.umn.edu/development/rfc/ms-rfc-27

Change History

Changed 7 years ago by dmorissette

  • component changed from MapServer C Library to MapServer Documentation

Changed 7 years ago by dmorissette

  • description modified (diff)

Changed 7 years ago by dmorissette

  • status changed from new to closed
  • resolution set to fixed

Done. The following has been added to the label object docs in the mapfile reference:

PRIORITY [integer]|[item_name]
     The priority parameter (added in v5.0) takes an integer value between 1 
     (lowest) and 10 (highest). The default value is 1. It is also possible
     to bind the priority to an attribute (item_name) using square brackets 
     around the [item_name]. e.g. "PRIORITY [someattribute]"

     Labels are stored in the label cache and rendered in order of priority, 
     with the highest priority levels rendered first.
     Specifying an out of range PRIORITY value inside a map file will result in
     a parsing error. An out of range value set via MapScript or coming from a 
     shape attribute will be clamped to the min/max values at rendering time.
     There is no expected impact on performance for using label priorities.
Note: See TracTickets for help on using tickets.