AddLeader

Adds an annotation leader to the document. Leader objects are planar. The 3-D points passed to this function should be co-planar.

Syntax

rhinoscriptsyntax.AddLeader ( points, view_or_plane=None, text=None )

rhinoscript.dimension.AddLeader ( points, view_or_plane=None, text=None )

Parameters

points

Required.  A list of 3-D points.  The array must contain at least two points.

view_or_plane

Optional.  String or Plane.  The title of the view.  If a view title is specified,  points will be constrained to the view's construction plane. If a view title is not specified, points will be constrained to a plane fit through the list of points.

text

Optional.  String.  The leader's text string.

Returns

Guid

The identifier of the new object if successful.

None

If not successful, or on error.

Example

import rhinoscriptsyntax as rs

points = rs.GetPoints(True, False, "Select leader points")

if points: rs.AddLeader( points )

Also See

IsLeader

LeaderText