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 Position of a View
func offset(x: CGFloat, y: CGFloat) -> OffsetChanges the relative position of this shape using the specified coordinates.
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 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 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.
Sizing a View
func frame(width: CGFloat?, height: CGFloat?, alignment: Alignment) -> ViewPositions the view within an invisible frame with the specified size.
func frame(minPositions the view within an invisible frame with the specified width and height.
func fixedFixes the view at its ideal size.
func fixedFixes the view at its ideal size in the specified dimensions.
func layoutSets the priority by which a parent layout should apportion space to the child.
Positioning a View
func position(CGPoint) -> ViewFixes the center of the view at the specified point in its parent’s coordinate space.
func position(x: CGFloat, y: CGFloat) -> ViewFixes the center of the view at the specified coordinates in its parent’s coordinate space.
func offset(CGSize) -> ViewOffsets the view by the horizontal and vertical distances in the given size.
func edgesExtends the view out of the safe area on the specified edges.
func coordinateAssigns a name to this view’s coordinate space to which descendants of this view can refer.
Aligning Views
func alignmentSets the view’s horizontal alignment.
func alignmentSets the view’s vertical alignment.
Adjusting the Padding of a View
func padding(CGFloat) -> ViewPads the view along all edge insets by the specified amount.
func padding(EdgePads the view using the specified edge insets.
func padding(EdgePads the view using the specified edge insets.
Layering Views
func overlay<Overlay>(Overlay, alignment: Alignment) -> ViewLayers a secondary view in front of the view.
func zControls the display order of overlapping views.
Setting the Border of a View
func border<S>(S, width: CGFloat) -> ViewAdds a border to the view with the specified style and width.
Masking and Clipping Views
func clipped(antialiased: Bool) -> ViewClips the view to its bounding rectangular frame.
func clipSets a clipping shape for the view.
func cornerClips the view to its bounding frame, with the specified corner radius.
func mask<Mask>(Mask) -> ViewMasks this view using the alpha channel of the given view.
Scaling Views
func scaledScales the view to fill its parent.
func scaledScales the view to fit its parent.
func scaleScales this view’s rendered output by the given amount in both the horizontal and vertical directions, relative to an anchor point.
func scaleScales this view’s rendered output by the given vertical and horizontal size amounts, relative to an anchor point.
func scaleScales this view’s rendered output by the given horizontal and vertical amounts, relative to an anchor point.
func aspectConstrains the view’s dimensions to the specified aspect ratio.
func aspectConstrains the view’s dimensions to the aspect ratio of the specified size.
func imageSets the scale of images inside the view.
Rotating and Transforming Views
func rotationRotates this view’s rendered output around the specified point.
func rotation3DEffect(Angle, axis: (x: CGFloat, y: CGFloat, z: CGFloat), anchor: UnitRotates this view’s rendered output in three dimensions around the given axis of rotation.
func projectionApplies a projection transformation to this view’s rendered output.
func transformApplies an affine transformation to this view’s rendered output.
Adjusting Text in a View
func keyboardSets the keyboard type for this view.
func font(Font?) -> ViewSets the default font for text in the view.
func lineSets the maximum number of lines that text can occupy in the view.
func lineSets the amount of space between lines of text in the view.
func minimumSets the minimum amount that text scales down to fit 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 can compress the space between characters when necessary to fit text in a line.
func textSets the text content type for this view, which the system uses to offer suggestions while the user enters text on an iOS or tvOS device.
func textSets the text content type for this view, which the system uses to offer suggestions while the user enters text on a watchOS device.
func flipsSets whether the view flips its contents horizontally when the layout direction is right-to-left.
func autocapitalization(UITextSets whether to apply auto-capitalization to this view.
func disableSets whether to disable autocorrection for this view.
Adding Animations to a View
func animation(Animation?) -> ViewApplies the given animation to all animatable values within the view.
func animation<V>(Animation?, value: V) -> ViewApplies the given animation to the view when the specified value changes.
func transition(AnyAssociates a transition with the view.
Handling View Taps and Gestures
func onAdds an action to perform when this view recognizes a tap gesture.
func onAdds an action to perform when this view recognizes a long press gesture.
func gesture<T>(T, including: GestureAttaches a gesture to the view with a lower precedence than gestures defined by the view.
func highAttaches a gesture to the view with a higher precedence than gestures defined by the view.
func simultaneousAttaches a gesture to the view to process simultaneously with gestures defined by the view.
func digitalTracks Digital Crown rotations by updating the specified binding.
func digitalTracks Digital Crown rotations by updating the specified binding.
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 the view appears.
func onAdds an action to perform when the view disappears.
func onAdds an action to perform in response to the system’s Cut command.
func onAdds an action to perform in response to the system’s Copy command.
func onAdds an action to perform in response to the system’s Paste command.
func onAdds an action to perform in response to the system’s Paste command with items that you validate.
func onAdds an action to perform in response to the system’s Delete command.
func onAdds an action to perform in response to a move command, like when the user presses an arrow key on a Mac keyboard, or taps the edge of the Siri Remote when controlling an Apple TV.
func onSets up an action that triggers in response to receiving the exit command while the view has focus.
func onAdds an action to perform in response to the system’s Play/Pause command.
func onAdds an action to perform in response to the given selector.
func deleteAdds a condition for whether the view’s view hierarchy is deletable.
func moveAdds a condition for whether the view's view hierarchy is movable.
Handling Publisher Events
func onAdds an action to perform when this view detects data emitted by the given publisher.
Handling View Hover and Focus
func onAdds an action to perform when the user moves the pointer over or away from the view’s frame.
func focusable(Bool, onSpecifies if the 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 the view as the source of a drag and drop operation.
func onDefines the destination of a drag and drop operation with the same size and position as the view using behavior controlled by the given delegate.
func onDefines the destination of a drag and drop operation with the same size and position as the view by handling dropped content and the drop location with the specified closure.
func onDefines the destination for a drag and drop operation with the same size and position as the view by handling dropped content with the specified closure.
func itemProvides a closure that vends the drag representation to be used for a particular data element.
Presenting Additional Views
func sheet<Content>(isPresents a sheet when a given condition is true.
func sheet<Item, Content>(item: Binding<Item?>, onPresents a sheet using the given item as a data source for the sheet’s content.
func actionPresents an action sheet when a given condition is true.
func actionPresents an action sheet using the given item as a data source for the sheet’s content.
func alert(isPresents an alert to the user.
func alert<Item>(item: Binding<Item?>, content: (Item) -> Alert) -> ViewPresents an alert to the user.
func popover<Content>(isPresents a popover when a given condition is true.
func popover<Item, Content>(item: Binding<Item?>, attachmentPresents a popover using the given item as a data source for the popover’s content.
Setting View Colors
func foregroundSets the color that the view uses for foreground elements.
func accentSets the accent color for the view and the views it contains.
Adopting View Color Schemes
func colorSets the view’s color scheme.
func preferredSets the preferred color scheme for this view.
Applying Graphical Effects to a View
func blur(radius: CGFloat, opaque: Bool) -> ViewApplies a Gaussian blur to the view.
func opacity(Double) -> ViewSets the transparency of the view.
func brightness(Double) -> ViewBrightens the view by the specified amount.
func contrast(Double) -> ViewSets the contrast and separation between similar colors in the view.
func colorInverts the colors in the view.
func colorAdds a color multiplication effect to the view.
func saturation(Double) -> ViewAdjusts the color saturation of the view.
func grayscale(Double) -> ViewAdds a grayscale effect to the view.
func hueApplies a hue rotation effect to the view.
func luminanceAdds a luminance to alpha effect to the view.
func shadow(color: Color, radius: CGFloat, x: CGFloat, y: CGFloat) -> ViewAdds a shadow to the view.
Compositing Views
func blendSets the blend mode for compositing the view with overlapping views.
func compositingWraps the view in a compositing group.
func drawingComposites the view’s contents into an offscreen image before final display.
Configuring Control Attributes
func labelsHides the labels of any controls contained within this view.
func defaultSets the default wheel-style picker item height.
func horizontalSets the style for radio group style pickers within the view’s environment to be radio buttons horizontally arranged inside of the layout.
func controlSets the size class, like regular or small, for controls within this view.
Styling Views
func buttonSets the style for buttons within this view.
func buttonSets the style for buttons within this view.
func menuSets the style for menu buttons within this view.
func pickerSets the style for pickers within this view.
func dateSets the style for date pickers within this view.
func textSets the style for text fields within this view.
func toggleSets the style for toggles within this view.
func listSets the style for lists within this view.
func navigationSets the style for navigation views within this view.
Configuring a List View
func listSets the inset to be applied to the view when placed in a list.
func listSets a view behind the view when placed in a list.
func listSets the color to apply to the system cell platter of the view when placed in a list.
func tag<V>(V) -> ViewSets a tag for the view in order to differentiate it from a list of view options.
Configuring Navigation and Status Bar Views
func navigationConfigures the title in the navigation bar for the view.
func navigationConfigures the title of the navigation bar for the view.
func navigationConfigures the title of this view's navigation bar with a localized string.
func navigationConfigures the title of this view’s navigation bar with a string.
func navigationConfigures the title of this view's navigation bar with a localized string and a display mode.
func navigationHides the navigation bar for the view.
func statusSets the visibility of the status bar for the view.
Configuring Navigation and Tab Bar Item Views
func navigationHides the navigation bar back button for the view.
func navigationConfigures the navigation bar items for the view.
func navigationConfigures the navigation bar items for the view.
func navigationConfigures the navigation bar items for the view.
func tabSets the tab bar item associated with this view.
Configuring Context Menu Views
func contextAttaches a contextual menu and its children to the view.
func contextAttaches a contextual menu to the view.
Configuring Touch Bar Views
func touchSets the content that the Touch Bar displays.
func touchSets the touch bar and its content to be shown in the Touch Bar when applicable.
func touchSets the view as having special significance to the TouchBar.
func touchSets a user-visible string identifying the view’s functionality.
func touchSets the behavior of the view when being customized by the user.
Hiding and Disabling Views
func hidden() -> ViewHides the view.
func disabled(Bool) -> ViewAdds a condition for whether users can interact with the view.
Customizing Accessibility Labels of a View
func accessibility(label: Text) -> ModifiedAdds a label to the view that describes its contents.
func accessibility(value: Text) -> ModifiedAdds a textual description of the value that the view contains.
func accessibility(hidden: Bool) -> ModifiedSpecifies whether to hide this view from system accessibility features.
func accessibility(identifier: String) -> ModifiedUses the specified string to identify the view.
func accessibility(selectionSets a selection identifier for this view’s accessibility element.
Customizing Accessibility Interactions of a View
func accessibility(hint: Text) -> ModifiedCommunicates to the user what happens after performing the view’s action.
func accessibility(activationSpecifies the unit point where activations occur in a view that’s an accessibility element.
func accessibility(activationSpecifies the point where activations occur in a view that’s an accessibility element.
func accessibilityAdds an accessibility action to this view.
func accessibilityAdds a custom accessibility action to the view.
func accessibilityAdds an accessibility adjustable action to the view.
func accessibilityAdds an accessibility scroll action to the view.
Customizing Accessibility Navigation of a View
func accessibilityWraps this view as a new accessibility element.
func accessibility(addAdds information about how the view behaves.
func accessibility(removeRemoves view behavior information that doesn’t apply to the view.
func accessibility(sortSets the sort priority order for this view’s accessibility element, relative to other elements at the same level.
Setting View Preferences
func preference<K>(key: KSets a value to return for the given preference key when accessed by ancestors.
func transformSets a callback to return a value for the given preference key when accessed by ancestors.
Responding to View Preferences
func onAdds an action to perform when the specified preference key’s value changes.
func backgroundUses the specified preference value from the view to produce another view as a background to the first view.
func overlayUses the specified preference value from the view to produce another view as an overlay atop the first view.
Setting the Environment Values of a View
func environment<V>(WritableSets the environment value indicated by a key path to the given value.
func transformTransforms the environment value indicated by a key path with the given function.
Configuring a View for Hit Testing
func allowsConfigures whether this view participates in hit test operations.
func contentDefines the content shape for hit testing.
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.
Inspecting Views
func id<ID>(ID) -> ViewGenerates a uniquely identified view that can be inserted or removed.
func equatable() -> EquatablePrevents the view from updating its child view when its new value is the same as its old value.
Implementing View Modifiers
func modifier<T>(T) -> ModifiedApplies a modifier to a view.
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.