struct · iOS 16.0+ · SDK 27.1
struct ChartProxyA proxy that you use to access the scales and plot area of a chart. You get a chart proxy from the <doc://com.apple.documentation/documentation/SwiftUI/View/chartOverlay(alignment:content:)> and <doc://com.apple.documentation/documentation/SwiftUI/View/chartBackground(alignment:content:)> modifiers. You can use the chart proxy to convert data values to screen coordinates or vice-versa. Below is an example where we convert the screen coordinates from a drag gesture to data values. ``` Chart(data) { LineMark( x: .value("date", $0.date), y: .value("price", $0.price) ) } .chartOverlay { proxy in GeometryReader { geometry in Rectangle().fill(.clear).contentShape(Rectangle()) .gesture( DragGesture() .onChanged { value in // Convert the gesture location to the coordinate space of the plot area. let origin = geometry[proxy.plotAreaFrame].origin let location = CGPoint( x: value.location.x - origin.x, y: value.location.y - origin.y ) // Get the x (date) and y (price) value from the location. let (date, price) = proxy.value(at: location, as: (Date, Double).self) print("Location: \(date), \(price)") } ) } } ```
symbolSize(value: number): (number) | nullfunc symbolSize<P>(for value: P) -> CGFloat? where P : PlottableReturns the symbol size for the given data value. Returns `nil` if the symbol size scale is unavailable, or the value is invalid. - Parameter value: The data value. - Returns: The symbol size corresponding to the data value, or `nil` if the data value is incompatible with the chart.
get plotAreaSize(): { width: number; height: number }var plotAreaSize: CGSize { get }The size of the plot in the chart. The plot is the area between the x and y axes, not including the axes themselves. A chart must exist in the context of the chart proxy.
selectXRange(from: number, to: number): voidfunc selectXRange(from: CGFloat, to: CGFloat)selectXValue(xPosition: number): voidfunc selectXValue(at xPosition: CGFloat)selectYRange(from: number, to: number): voidfunc selectYRange(from: CGFloat, to: CGFloat)selectYValue(yPosition: number): voidfunc selectYValue(at yPosition: CGFloat)symbolDomain(dataType: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): Array<unknown>func symbolDomain<P>(dataType: P.Type) -> [P] where P : Plottableget plotAreaFrame(): _SwiftUICore_Anchor<{ x: number; y: number; width: number; height: number }>var plotAreaFrame: Anchor<CGRect> { get }An anchor to the frame of the chart's plot. The plot is the area between the x and y axes, not including the axes themselves. If the chart is scrollable, the plot frame includes both visible and invisible portions of the plot. A chart must exist in the context of the chart proxy. You can convert the anchor to a frame using a `GeometryProxy`.
positionRangeFor(point: { "x": number; "y": number }): ({ x: number; y: number; width: number; height: number }) | nullfunc positionRange<X, Y>(for point: (x: X, y: Y)) -> CGRect? where X : Plottable, Y : PlottableReturns the range of x and y positions for the given pair of data values, or `nil` if the y scale is unavailable or if the value is invalid. For a continuous data value, the returned range is a single point. For a categorical data value, the returned range is the range of positions that correspond to the given category. - Parameter value: The data value. - Returns: The position range corresponding to the data values.
positionRangeForX(value: number): ("animatableData" | SDKHandle) | nullfunc positionRange<P>(forX value: P) -> ClosedRange<CGFloat>? where P : PlottableReturns the range of x position for the given data value, or `nil` if the x scale is unavailable or if the value is invalid. The returned position range is relative to the plot. For a continuous data value, the returned range is a single point. For a categorical data value, the returned range is the range of positions that correspond to the given category. - Parameter value: The data value. - Returns: The position range corresponding to the data value.
positionRangeForY(value: number): ("animatableData" | SDKHandle) | nullfunc positionRange<P>(forY value: P) -> ClosedRange<CGFloat>? where P : PlottableReturns the range of y position for the given data value, or `nil` if the x scale is unavailable or if the value is invalid. The returned position range is relative to the plot. For a continuous data value, the returned range is a single point. For a categorical data value, the returned range is the range of positions that correspond to the given category. - Parameter value: The data value. - Returns: The position range corresponding to the data value.
foregroundStyle(value: number): (_SwiftUICore_AnyShapeStyle) | nullfunc foregroundStyle<P>(for value: P) -> AnyShapeStyle? where P : PlottableReturns the foreground style for the given data value. Returns `nil` if the foreground style scale is unavailable, or the value is invalid. - Parameter value: The data value. - Returns: The foreground style corresponding to the data value, or `nil` if the data value is incompatible with the chart.
lineStyleDomain(dataType: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): Array<unknown>func lineStyleDomain<P>(dataType: P.Type) -> [P] where P : PlottableselectAngleValue(angle: _SwiftUICore_Angle): voidfunc selectAngleValue(at angle: Angle)symbolSizeDomain(dataType: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): Array<unknown>func symbolSizeDomain<P>(dataType: P.Type) -> [P] where P : Plottableget plotContainerFrame(): (_SwiftUICore_Anchor<{ x: number; y: number; width: number; height: number }>) | nullvar plotContainerFrame: Anchor<CGRect>? { get }An anchor to the frame of the chart's plot container, or `nil` if there is no chart in the context of the chart proxy. The plot is the area between the x and y axes, not including the axes themselves. If the chart is scrollable, the plot container frame only includes the visible portion of the plot. Otherwise, it is the same as ``plotFrame``. You can convert the anchor to a frame using a `GeometryProxy`. Below is an example adding a border to the plot container: ``` Chart { ... } .chartOverlay { chartProxy in GeometryReader { geometryProxy in // Get the plot container's frame in the GeometryReader's coordinate space. // This frame stays the same when the chart scrolls. // In this example, we add a border to the plot container by stroking the frame. if let plotContainerFrame = chartProxy.plotContainerFrame { Path(geometryProxy[plotContainerFrame]) .stroke(.black, lineWidth: 1) .allowsHitTesting(false) } } } ```
foregroundStyleDomain(dataType: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): Array<unknown>func foregroundStyleDomain<P>(dataType: P.Type) -> [P] where P : Plottableangle(position: { x: number; y: number }): _SwiftUICore_Anglefunc angle(at position: CGPoint) -> AngleReturns the angle relative to the plot area center, where the 12 o'clock position is interpreted as zero degrees, increasing clockwise. - Parameter position: The position at which to obtain the data value. It should be relative to the plot. - Returns: The angle relative to the plot area center.
valueAt(position: { x: number; y: number }): ([number, number]) | nullfunc value<X, Y>(at position: CGPoint, as: (X, Y).Type = (X, Y).self) -> (X, Y)? where X : Plottable, Y : PlottableReturns the data values at the given position, or `nil` if the position does not correspond to a valid Y value. - Parameter position: The position at which to obtain the data values. It should be relative to the plot. - Returns: A tuple of the x and y data values at the given position.
valueAtXAs(position: number, as?: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): (unknown) | nullfunc value<P>(atX position: CGFloat, as: P.Type = P.self) -> P? where P : PlottableReturns the data value at the given x position, or `nil` if the position does not correspond to a valid X value. - Parameter position: The position at which to obtain the x data value. It should be relative to the plot. - Returns: The data value at the given position.
valueAtYAs(position: number, as?: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): (unknown) | nullfunc value<P>(atY position: CGFloat, as: P.Type = P.self) -> P? where P : PlottableReturns the data value at the given y position, or `nil` if the position does not correspond to a valid Y value. - Parameter position: The position at which to obtain the y data value. It should be relative to the plot. - Returns: The data value at the given position.
valueAtAngleAs(angle: _SwiftUICore_Angle, as?: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): (unknown) | nullfunc value<P>(atAngle angle: Angle, as: P.Type = P.self) -> P? where P : PlottableReturns the data value at the given angle, or `nil` if the angle does not correspond to a valid data value. - Parameter angle: The angle, relative to the plot center, where the 12 o'clock position is interpreted as zero degrees, increasing clockwise. - Returns: The data value at the given position.
symbol(value: number): (AnyChartSymbolShape) | nullfunc symbol<P>(for value: P) -> AnyChartSymbolShape? where P : PlottableReturns the symbol for the given data value. Returns `nil` if the symbol scale is unavailable, or the value is invalid. - Parameter value: The data value. - Returns: The symbol corresponding to the data value, or `nil` if the data value is incompatible with the chart.
xDomain(dataType: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): Array<unknown>func xDomain<P>(dataType: P.Type) -> [P] where P : PlottableyDomain(dataType: "Int" | "UInt" | "Double" | "Float" | "String" | "Date" | "Foundation.Decimal"): Array<unknown>func yDomain<P>(dataType: P.Type) -> [P] where P : Plottableget plotSize(): { width: number; height: number }var plotSize: CGSize { get }The size of the plot in the chart. The plot is the area between the x and y axes, not including the axes themselves.
positionFor(point: { "x": number; "y": number }): ({ x: number; y: number }) | nullfunc position<X, Y>(for point: (x: X, y: Y)) -> CGPoint? where X : Plottable, Y : PlottableReturns the x and y positions as a `CGPoint` for the given data values, or `nil` if either the X or the y scale is unavailable or if any data value is invalid. The returned position is relative to the plot. - Parameter point: A tuple of x and y data values. - Returns: The position corresponding to the data values.
positionForX(value: number): (number) | nullfunc position<P>(forX value: P) -> CGFloat? where P : PlottableReturns the x position for the given data value, or `nil` if the x scale is unavailable or if the data value is invalid. The returned position is relative to the plot. - Parameter value: A data value. - Returns: The position corresponding to the data value.
positionForY(value: number): (number) | nullfunc position<P>(forY value: P) -> CGFloat? where P : PlottableReturns the y position for the given data value, or `nil` if the y scale is unavailable or if the data value is invalid. The returned position is relative to the plot. - Parameter value: A data value. - Returns: The position corresponding to the data value.
lineStyle(value: number): (_SwiftUICore_StrokeStyle) | nullfunc lineStyle<P>(for value: P) -> StrokeStyle? where P : PlottableReturns the line style for the given data value. Returns `nil` if the line style scale is unavailable, or the value is invalid. - Parameter value: The data value. - Returns: The line style corresponding to the data value, or `nil` if the data value is incompatible with the chart.
get plotFrame(): (_SwiftUICore_Anchor<{ x: number; y: number; width: number; height: number }>) | nullvar plotFrame: Anchor<CGRect>? { get }An anchor to the frame of the chart's plot, or `nil` if there is no chart in the context of the chart proxy. The plot is the area between the x and y axes, not including the axes themselves. If the chart is scrollable, the plot frame includes both visible and invisible portions of the plot. You can convert the anchor to a frame using a `GeometryProxy`.
No declarations were skipped in this snapshot.