The outline of a 2D shape.
SDKs
- iOS 13.0+
- macOS 10.15+
- Mac Catalyst 13.0+
- tvOS 13.0+
- watchOS 6.0+
- Xcode 11.0+
Framework
- Swift
UI
Declaration
@frozen struct Path
Structure
Path
Topics
Setting the Size of a View
func frame(width: CGFloat?, height: CGFloat?, alignment: Alignment) -> ViewPositions this view within an invisible frame with the specified size.
func frame(minPositions this view within an invisible frame with the specified width and height characteristics.
func fixedFixes this view at its ideal size.
func fixedFixes this view at its ideal size in the specified dimensions.
Specifying the Relative Size of a View
func layoutSets the priority by which a parent layout should apportion space to this child.
Setting the Position of a View
func position(CGPoint) -> ViewFixes the center of this view at the specified point in its parent’s coordinate space.
func position(x: CGFloat, y: CGFloat) -> ViewFixes the center of this view at the specified coordinates in its parent’s coordinate space.
func offset(CGSize) -> ViewOffsets this view by the horizontal and vertical distances in the given size.
func offset(x: CGFloat, y: CGFloat) -> OffsetChanges the relative position of this shape using the specified coordinates.
func edgesExtends the view out of the safe area on the specified edges.
Aligning Views
func alignmentReturns a view modified so that its value for the given guide is the result of passing the View of the underlying view to compute.
func alignmentReturns a view modified so that its value for the given guide is the result of passing the View of the underlying view to compute.
Adjusting the Padding of a View
func padding(CGFloat) -> ViewPads this view along all edge insets by the amount you specify.
func padding(EdgePads this view using the edge insets you specify.
func padding(EdgePads this view using the edge insets you specify.
Setting the Foreground or Background of a View
func overlay<Overlay>(Overlay, alignment: Alignment) -> ViewLayers a secondary view in front of this view.
func foregroundSet the foreground color within self.
func zSets the Z index for an item.
Setting the Border of a View
func border<S>(S, width: CGFloat) -> ViewAdds a border to this view with the specified style and width.
Masking and Clipping Views
func clipped(antialiased: Bool) -> ViewClips this view to its bounding rectangular frame.
func clipSets a clipping shape for this view.
func cornerClips this view to its bounding frame, with the specified corner radius.
Scaling Views
func scaledScales this view to fill its parent.
func scaledScales this view to fit its parent.
func aspectConstrains this view’s dimensions to the specified aspect ratio.
func aspectConstrains this view’s dimensions to the aspect ratio of the given size.
func imageSet the image scale within self.
Rotating and Transforming Views
Adjusting Text in a View
func font(Font?) -> ViewSets the default font for text in this view.
func lineSets the maximum number of lines that text can occupy in this view.
func lineSets the amount of space between lines of text in this view.
func minimumSets the minimum amount that text in this view scales down to fit in the available space.
func truncationSets the truncation mode for lines of text that are too long to fit in the available space.
func allowsSets whether text in this view can compress the space between characters when necessary to fit text in a line.
func flipsSets whether this view flips its contents horizontally when the layout direction is right-to-left.
Adding Animations to a View
func animation(Animation?) -> ViewApplies the given animation to all animatable values within this view.
func animation<V>(Animation?, value: V) -> ViewApplies the given animation to this view, whenever the specified value changes.
func transition(AnyAssociates a transition with self.
Handling View Taps and Gestures
func itemProvides a closure that vends the drag representation to be used for a particular Dynamic.
func transaction((inout Transaction) -> Void) -> ViewApplies the given transaction mutation function to all transactions used within the view.
Handling View Events
func onAdds an action to perform when this view appears.
func onAdds an action to perform when this view disappears.
Handling View Hover and Focus
func onAdds an action to perform when the user moves the pointer over or away from this view’s frame.
func focusable(Bool, onSets whether this view is focusable and, if so, adds an action to perform when the view comes into focus.
Supporting Drag and Drop in Views
func onActivates this view as the source of a drag and drop operation.
func onDefines the destination for a drag and drop operation with the same size and position as this view, with behavior controlled by the given delegate.
func onDefines the destination for a drag and drop operation with the same size and position as this view, handling dropped content and the drop location with the given closure.
func onDefines the destination for a drag and drop operation, using the same size and position as this view, handling dropped content with the given closure.
Adopting View Color Schemes
func colorSets this view’s color scheme.
func accentSets the accent color for this view and the views it contains.
Applying Blurs and Shadows to a View
func blur(radius: CGFloat, opaque: Bool) -> ViewApplies a Gaussian blur to this view.
func shadow(color: Color, radius: CGFloat, x: CGFloat, y: CGFloat) -> ViewAdds a shadow to this view.
Applying Graphical Effects to a View
func opacity(Double) -> ViewSets the transparency of this view.
func brightness(Double) -> ViewBrightens this view by the specified amount.
func contrast(Double) -> ViewSets the contrast and separation between similar colors in this view.
func colorInverts the colors in this view.
func colorAdds a color multiplication effect to this view.
func blendSets the blend mode for compositing this view with overlapping views.
func compositingWraps this view in a compositing group.
func drawingComposites this view’s contents into an offscreen image before final display.
func saturation(Double) -> ViewAdjusts the color saturation of this view.
func grayscale(Double) -> ViewAdds a grayscale effect to this view.
func hueApplies a hue rotation effect to this view.
func luminanceAdds a luminance to alpha effect to this view.
Styling Control Views
Configuring a List View
func listSets the inset to be applied to self in a List.
func listSets the view to be placed behind self when placed in a List
func listSets the color to be apply to the system cell platter when self is placed in a List
Configuring Context Menu Views
func contextAttaches a Context and its children to self.
func contextAdds a contextual menu to this view.
Configuring Touch Bar Views
func touchSets the Touch and its content to be shown in the Touch Bar when applicable
func touchPrincipal views have special significance to this TouchBar. Currently, that item will be placed in the center of the row.
func touchThe user-visible String identifying the view’s functionality. Visible during user customization.
func touchThe behavior of the view when being customized by the user. Views may be:
Hiding and Disabling Views
func hidden() -> ViewHides this view.
func disabled(Bool) -> ViewAdds a condition that controls whether users can interact with this view.
func deleteAdds a condition for whether the view hierarchy for self can be deleted.
func moveAdds a condition for whether the view hierarchy for self can be moved.
Setting View Preferences
func preference<K>(key: KReturns a view producing value as the value of preference Key seen by its ancestors.
func transformReturns a view that applies callback(&value) to the value of preference Key that’s seen by its ancestors.
Responding to View Preferences
func onAdds an action to perform when the specified preference key’s value changes.
func backgroundReturns a view that reads the value of preference Key from self, uses that to produce another view which is displayed as as the background to self.
func overlayReturns a view that reads the value of preference Key from self, uses that to produce another view which is displayed as an overlay on self.
Setting the Environment Values of a View
func environment<V>(WritableReturns a view wrapping self that sets a value for an environment key.
func transformReturns a view wrapping self that transforms the value of the environment key described by key by applying a transform function.
Configuring a View for Hit Testing
func contentReturns a new view that defines the content shape for hit-testing self as shape. eo defines whether the shape is interpreted using the even-odd winding number rule or not.
Configuring View Previews
func previewOverrides the device for a preview.
func previewProvides a user visible name shown in the editor.
func previewOverrides the size of the container for the preview.
Deprecated
func equatable() -> EquatableReturns a new view that will prevent self updating its child view when its new value is the same as its old value.
Type Aliases
Initializers
init()Creates an empty path.
init(CGMutableCreates a path from a copy of a mutable shape path.
init(CGPath)Creates a path from an immutable shape path.
init((inout Path) -> ())Creates an empty path, and then executes the closure to add the initial elements.
init(CGRect)Creates a path as the given rectangle.
init(ellipseCreates a path as an ellipse inscribed within the given rectangle.
init(roundedCreates a path as the given rounded rectangle.
init(roundedCreates a path as the given rounded rectangle.
Instance Properties
var animatableThe data to be animated.
var boundingA rectangle containing all path segments.
var cgAn immutable path representing the elements in the path.
var isA Boolean value indicating whether the path contains zero elements.
Instance Methods
func addAdds an arc of a circle to the path, specified with a radius and angles.
func addAdds an arc of a circle to the path, specified with a radius and two tangent lines.
func addAdds a cubic Bézier curve to the path, with the specified end point and control points.
func addAdds an ellipse to the path.
func addAppends a straight line segment from the current point to the specified point.
func addAdds a sequence of connected straight-line segments to the path.
func addAppends a copy of path to the path.
func addAdds a quadratic Bézier curve to the path, with the specified end point and control point.
func addAdds a rectangular subpath to the path.
func addAdds a sequence of rectangular subpaths to the path.
func addAdds an arc of a circle to the path, specified with a radius and a difference in angle.
func addAdds a rounded rectangle to the path.
func applying(CGAffineReturns a path constructed by applying the transform to all points of the path.
func closeCloses and completes the current subpath.
func contains(CGPoint, eoReturns true if the path contains a specified point.
func defaultSets the default .wheel style Picker item height within self.
func digitalTracks Digital Crown rotations by updating the given binding.
func digitalTracks Digital Crown rotations by updating the given binding.
func forCalls body with each element in the path.
func move(to: CGPoint)Begins a new subpath at the specified point.
func offset(CGSize) -> OffsetChanges the relative position of this shape using the specified size.
func offset(CGPoint) -> OffsetChanges the relative position of this shape using the specified point.
func offsetReturns a path constructed by translating self by (dx, dy).
func rotation(Angle, anchor: UnitRotates this shape around an anchor point at the angle you specify.
func scale(CGFloat, anchor: UnitScales this shape without changing its bounding frame.
func scale(x: CGFloat, y: CGFloat, anchor: UnitScales this shape without changing its bounding frame.
func strokedReturns a stroked copy of the path using style to define how the stroked outline is created.
func tag<V>(V) -> ViewSets the tag of the view, used for selecting from a list of View options.
func transform(CGAffineApplies an affine transform to this shape.
func trimmedReturns a partial copy of the path.
Operator Functions
static func != (Path, Path) -> BoolReturns a Boolean value indicating whether two values are not equal.
Enumerations
enum PathAn element of a path.
Relationships
Conforms To
See Also
Shapes
struct RectangleA rectangular shape aligned inside the frame of the view containing it.
enum EdgeAn enumeration to indicate one edge of a rectangle.
struct RoundedA rectangular shape with rounded corners, aligned inside the frame of the view containing it.
struct CircleA circle centered on the frame of the view containing it.
struct EllipseAn ellipse aligned inside the frame of the view containing it.
struct CapsuleA capsule shape aligned inside the frame of the view containing it.