Syntax

   FACTORY_DEF <ReaderKeyword> LabelFactory
   [FACTORY_NAME <factory name>]
   [INPUT FEATURE_TYPE <feature type>
   [<attribute name> <attribute value>]*
   [<feature function>]*]*
   [PLACEMENT (UPPER_RIGHT|UPPER_LEFT|LOWER_RIGHT| LOWER_LEFT|RIGHT|LEFT)]
   [PLACEMENT_DISTANCE <distance from line>]
   [PLACEMENT_SPACING <distance along line>]
   [LABEL_ALWAYS_ROTATE <yes|no>]
   [TREAT_NONLINE_SPECIAL <yes|no>]
   [MINIMUM_LENGTH <length>]
   [LABEL_ENDS [<boolean value>]]
   [LABEL_FIELD <attribute name>]
   [LABEL_TEXT <FMEParsableText encoded text>]
   [LABEL_HEIGHT <label height in real world coords>]
   [AVERAGE_CHAR_WIDTH <avg. char. width in real world coords>]
   [FLUSH_LABELS <boolean value>]
   [HANDLE_ARCS_AND_ELLIPSES [(yes|no)]]
   [OUTPUT (POINT|ORIGINAL)
   FEATURE_TYPE <feature type>
   [<attribute name> <attribute value>]*
   [<feature function>]*]*

Overview

   Note: This factory is not supported by FME Base Edition.

   This factory accepts linear and polygonal features and outputs one or more
   label point features that are spaced along the line as specified by
   PLACEMENT_SPACING clause. If PLACEMENT_SPACING is not specified then a single
   point is generated at the midpoint of the linear feature as long as
   LABEL_ENDS is set to "no". The value may be specified as a constant, or as an
   attribute value or as the output of a function.

   TREAT_NONLINE_SPECIAL is used to indicate that all features with an
   fme_type other than line should be replaced with a single point.

   The output point features have all the attributes of the associated input
   linear feature from which they were derived as well as a LabelRotation
   attribute that contains the rotation of the label point. This rotation is
   adjusted so that text oriented at the label point will be parallel to the
   line segment and will not be upside down or right-to-left. Setting
   LABEL_ALWAYS_ROTATE to "no" will prevent this rotational adjustment from
   happening. In addition, the output point features have a ParallelRotation
   attribute which contains the true orientation of the line at the label point.
   This rotation can be used to place a symbol that indicates the direction of
   the line.

   The output label point features are a PLACEMENT_DISTANCE from the closest
   point on the line. If PLACEMENT_DISTANCE is not specified then the point(s)
   are located on the linear feature. The value may be specified as a constant,
   or as an attribute value or as the output of a function.

   When generated label points are a PLACEMENT_DISTANCE measured perpendicularly
   from the closest point on the line. The placement points are placed relative
   to the line as specified by the PLACEMENT clause. If UPPER_RIGHT is
   specified, then the points are located a PLACEMENT_DISTANCE above (or to the
   right if the line is vertical) the line. UPPER_LEFT is nearly identical
   except that if the line is vertical, the label point will be to the left of
   the linear feature. LOWER_LEFT and LOWER_RIGHT work similarly with all label
   points being below the linear feature unless it is vertical in which case the
   label points are to the left and right for LOWER_LEFT and LOWER_RIGHT,
   respectively. If RIGHT is specified then the text is to the RIGHT of the
   line. If LEFT is specified then the text is to the LEFT of the line.

   If the optional MINUMUM_LENGTH clause is specified, it indicates the minimum
   length line which will have a label generated for it. If the line's length is
   less than this minimum, then no label will be generated for it. The value may
   be specified as a constant, or as an attribute value or as the output of a
   function.

   If the optional LABEL_ENDS clause is specified, label points will be
   generated at the start and end point of the feature. If it is not specified,
   no label points are generated at the feature ends. The value may be specified
   as a Boolean constant, or as an attribute value or as the output of a
   function.

   The optional LABEL_FIELD, LABEL_TEXT, LABEL_HEIGHT, and AVERAGE_CHAR_WIDTH clauses are
   used to output label points whose labels do not overlap.  Only one of LABEL_TEXT and
   LABEL_FIELD should be specified.  Use LABEL_FIELD to have label taken from an attribute
   and LABEL_TEXT to specify the text directly.

   The LabelFactory uses the LABEL_HEIGHT and AVERAGE_CHAR_WIDTH to calculate
   the LABEL_FIELD bounding box. It then uses the bounding boxes to output non-
   overlapping labels. These values may be specified as a constants, as
   attribute values or as the output of functions. If the AVERAGE_CHAR_WIDTH is
   not specified or its final value is 0.0, then the LABEL_HEIGHT value will be
   taken as the value for the AVERAGE_CHAR_WIDTH.

   The optional FLUSH_LABELS clause allows input features to carry a Boolean
   attribute that will indicate if the factory needs to flush its current
   indexed labels. These indexed labels are kept by the factory to calculate
   label overlap. If specified, the value for this attribute should NOT be a
   Boolean constant; instead it should be specified as an attribute value or as
   the output of a function.

   Any non-linear features which are input into the factory are output via the
   ORIGINAL tag untouched. All input features are also output untouched via the
   ORIGINAL tag.

Output Tags

   The LabelFactory supports the following output tags.

   ORIGINAL

   The original features are all output here regardless of input geometry
   Points without a primary axis and features with null attributes are output
   type. Only linear and polygonal features are used to generate label

   REJECTED

      Points without a primary axis and features with null attributes are output
      here.

   POINT

      The label point features are output here. Each label point feature has all
      attributes and feature type of the linear feature from which it was
      generated with the new attribute LabelRotation being added so that when
      used to place text, the text is parallel to the linear feature and
      adjusted to read in a pleasant manner. In addition, the feature will have
      a ParallelRotation attribute which contains the true orientation of the
      feature at the label point. This rotation can be used to place a symbol
      rather than text.