GoJS API
/ to search
    Preparing search index...

    Class PathFigure

    A PathFigure represents a section of a Geometry. It is a single connected series of two-dimensional geometric PathSegments.

    The Geometry.figures property is a list of PathFigures.

    PathFigures are drawn with the Shape.stroke and other stroke properties. Filled PathFigures are painted with the Shape.fill.

    A PathFigure must not be modified once its containing Geometry has been assigned to a Shape.

    Index

    Constructors

    • Constructs an empty figure. The optional arguments specify the starting point of the figure. You'll want to add a new instance of a PathFigure to the Geometry.figures list of a Geometry.

      Parameters

      • Optionalsx: number

        optional: the X coordinate of the start point (default is zero).

      • Optionalsy: number

        optional: the Y coordinate of the start point (default is zero).

      • Optionalfilled: boolean

        optional: whether the figure is filled (default is true).

      • Optionalshadowed: boolean

        optional: whether the figure may be drawn with a shadow (default is true).

      • OptionalisEvenOdd: boolean

        optional: whether uses the even-odd rule (true) or nonzero winding number rule (the default, false).

      Returns PathFigure

    Accessors

    • get isEvenOdd(): boolean

      Gets or sets whether this PathFigure will render and hit-test with the even-odd fill rule or nonzero winding number fill rule (false). The default value is false, using the nonzero winding number rule.

      In Geometry Path Strings, this is set by using "F0" instead of "F" at the beginning of a figure.

      Returns boolean

      since

      2.3

    • get isFilled(): boolean

      Gets or sets whether this PathFigure is drawn filled. The default value is true.

      Returns boolean

    • get isShadowed(): boolean

      Gets or sets whether this PathFigure will render a shadow if one is defined. This is used for turning off shadows on specific subpaths. The default value is true.

      Returns boolean

    • get startX(): number

      Gets or sets the starting point X coordinate of the PathFigure. The default value is zero.

      Returns number

    • get startY(): number

      Gets or sets the starting point Y coordinate of the PathFigure. The default value is zero.

      Returns number

    Methods

    • Create a copy of this PathFigure, with the same values and segments.

      Returns PathFigure