PointOfInterestProtocol

public protocol PointOfInterestProtocol

Undocumented

Ordinate

MarkerShape
A type representing a Shape for displaying a line as a POI.
Declaration
Swift

associatedtype MarkerShape : Shape


                    
                    
                    poiMarker(value:range:minValue:)

Displays a line marking a Point Of Interest.

In standard charts this will return a horizontal line. In horizontal charts this will return a vertical line.

Declaration

Swift

func poiMarker(value: Double, range: Double, minValue: Double) -> MarkerShape

Parameters

`value`	Value of of the POI.
`range`	Difference between the highest and lowest values in the data set.
`minValue`	Lowest value in the data set.

Return Value

A line shape at a specified point.

LabelAxis
A type representing a View for displaying a label as a POI in an axis.
Declaration
Swift

associatedtype LabelAxis : View
poiLabelAxis(markerValue:specifier:formatter:labelFont:labelColour:labelBackground:labelBorderColor:customLabelShape:padding:)
Displays a label and box that mark a Point Of Interest in an axis.

In standard charts this will display leading or trailing. In horizontal charts this will display bottom or top.
Declaration
Swift

func poiLabelAxis(markerValue: Double, specifier: String, formatter: NumberFormatter?, labelFont: Font, labelColour: Color, labelBackground: Color, labelBorderColor: Color, customLabelShape: CustomLabelShape?, padding: CGFloat?) -> LabelAxis
LabelCenter
A type representing a View for displaying a label as a POI in the center.
Declaration
Swift

associatedtype LabelCenter : View
poiLabelCenter(markerValue:specifier:formatter:labelFont:labelColour:labelBackground:labelBorderColor:strokeStyle:customLabelShape:padding:)
Displays a label and box that mark a Point Of Interest in the center.

In standard charts this will display leading or trailing. In horizontal charts this will display bottom or top.
Declaration
Swift

func poiLabelCenter(markerValue: Double, specifier: String, formatter: NumberFormatter?, labelFont: Font, labelColour: Color, labelBackground: Color, labelBorderColor: Color, strokeStyle: StrokeStyle, customLabelShape: CustomLabelShape?, padding: CGFloat?) -> LabelCenter
LabelPosition
A type representing a View for displaying a label as a POI at a relative location from the leading axis.
Declaration
Swift

associatedtype LabelPosition : View
poiLabelPosition(location:markerValue:specifier:formatter:labelFont:labelColour:labelBackground:labelBorderColor:strokeStyle:customLabelShape:padding:)
Displays a label and box that mark a Point Of Interest at a relative location from the axis.

In standard charts this will display leading or trailing. In horizontal charts this will display bottom or top.
Declaration
Swift

func poiLabelPosition(location: CGFloat, markerValue: Double, specifier: String, formatter: NumberFormatter?, labelFont: Font, labelColour: Color, labelBackground: Color, labelBorderColor: Color, strokeStyle: StrokeStyle, customLabelShape: CustomLabelShape?, padding: CGFloat?) -> LabelPosition


                    
                    
                    poiValueLabelPositionAxis(frame:markerValue:minValue:range:)

Sets the position of the POI Label when it’s over one of the axes.

Declaration

Swift

func poiValueLabelPositionAxis(frame: CGRect, markerValue: Double, minValue: Double, range: Double) -> CGPoint

Parameters

`frame`	Size of the chart.
`markerValue`	Value of the POI marker.
`minValue`	Lowest value in the data set.
`range`	Difference between the highest and lowest values in the data set.

Return Value

Position of label.


                    
                    
                    poiValueLabelPositionCenter(frame:markerValue:minValue:range:)

Sets the position of the POI Label when it’s in the center of the view.

Declaration

Swift

func poiValueLabelPositionCenter(frame: CGRect, markerValue: Double, minValue: Double, range: Double) -> CGPoint

Parameters

`frame`	Size of the chart.
`markerValue`	Value of the POI marker.
`minValue`	Lowest value in the data set.
`range`	Difference between the highest and lowest values in the data set.

Return Value

Position of label.


                    
                    
                    poiValueLabelRelativePosition(frame:markerValue:minValue:range:)

Sets the position of the POI Label when it’s at a relative location from the leading axis.

Declaration

Swift

func poiValueLabelRelativePosition(frame: CGRect, markerValue: Double, minValue: Double, range: Double) -> CGPoint

Parameters

`frame`	Size of the chart.
`markerValue`	Value of the POI marker.
`minValue`	Lowest value in the data set.
`range`	Difference between the highest and lowest values in the data set.

Return Value

Position of label.

Abscissa

AbscissaMarkerShape
A type representing a Shape for displaying a line as a POI.
Declaration
Swift

associatedtype AbscissaMarkerShape : Shape


                    
                    
                    poiAbscissaMarker(markerValue:dataPointCount:)

Displays a line marking a Point Of Interest.

In standard charts this will return a horizontal line. In horizontal charts this will return a vertical line.

Declaration

Swift

func poiAbscissaMarker(markerValue: Int, dataPointCount: Int) -> AbscissaMarkerShape

Parameters

`value`	Value of of the POI.
`range`	Difference between the highest and lowest values in the data set.
`minValue`	Lowest value in the data set.

Return Value

A line shape at a specified point.

AbscissaLabelAxis
A type representing a View for displaying a label as a POI in an axis.
Declaration
Swift

associatedtype AbscissaLabelAxis : View
poiAbscissaLabelAxis(marker:labelFont:labelColour:labelBackground:labelBorderColor:customLabelShape:padding:)
Displays a label and box that mark a Point Of Interest in an axis.

In standard charts this will display leading or trailing. In horizontal charts this will display bottom or top.
Declaration
Swift

func poiAbscissaLabelAxis(marker: String, labelFont: Font, labelColour: Color, labelBackground: Color, labelBorderColor: Color, customLabelShape: CustomLabelShape?, padding: CGFloat?) -> AbscissaLabelAxis
AbscissaLabelCenter
A type representing a View for displaying a label as a POI in an axis.
Declaration
Swift

associatedtype AbscissaLabelCenter : View
poiAbscissaLabelCenter(marker:labelFont:labelColour:labelBackground:labelBorderColor:strokeStyle:customLabelShape:padding:)
Displays a label and box that mark a Point Of Interest in an axis.

In standard charts this will display leading or trailing. In horizontal charts this will display bottom or top.
Declaration
Swift

func poiAbscissaLabelCenter(marker: String, labelFont: Font, labelColour: Color, labelBackground: Color, labelBorderColor: Color, strokeStyle: StrokeStyle, customLabelShape: CustomLabelShape?, padding: CGFloat?) -> AbscissaLabelCenter
AbscissaLabelPosition
A type representing a View for displaying a label as a POI at a relative location from the leading axis.
Declaration
Swift

associatedtype AbscissaLabelPosition : View
poiAbscissaLabelPosition(location:marker:labelFont:labelColour:labelBackground:labelBorderColor:strokeStyle:customLabelShape:padding:)
Displays a label and box that mark a Point Of Interest at a relative location from the leading axis.

In standard charts this will display leading or trailing. In horizontal charts this will display bottom or top.
Declaration
Swift

func poiAbscissaLabelPosition(location: CGFloat, marker: String, labelFont: Font, labelColour: Color, labelBackground: Color, labelBorderColor: Color, strokeStyle: StrokeStyle, customLabelShape: CustomLabelShape?, padding: CGFloat?) -> AbscissaLabelPosition


                    
                    
                    poiAbscissaValueLabelPositionAxis(frame:markerValue:count:)

Sets the position of the POI Label when it’s over one of the axes.

Declaration

Swift

func poiAbscissaValueLabelPositionAxis(frame: CGRect, markerValue: Int, count: Int) -> CGPoint

Parameters

`frame`	Size of the chart.
`markerValue`	Value of the POI marker.
`minValue`	Lowest value in the data set.
`range`	Difference between the highest and lowest values in the data set.

Return Value

Position of label.


                    
                    
                    poiAbscissaValueLabelPositionCenter(frame:markerValue:count:)

Sets the position of the POI Label when it’s in the center of the view.

Declaration

Swift

func poiAbscissaValueLabelPositionCenter(frame: CGRect, markerValue: Int, count: Int) -> CGPoint

Parameters

`frame`	Size of the chart.
`markerValue`	Value of the POI marker.
`minValue`	Lowest value in the data set.
`range`	Difference between the highest and lowest values in the data set.

Return Value

Position of label.


                    
                    
                    poiAbscissaValueLabelRelativePosition(frame:markerValue:count:)

Sets the position of the POI Label when it’s at a relative location from the leading axis.

Declaration

Swift

func poiAbscissaValueLabelRelativePosition(frame: CGRect, markerValue: Int, count: Int) -> CGPoint

Parameters

`frame`	Size of the chart.
`markerValue`	Value of the POI marker.
`minValue`	Lowest value in the data set.
`range`	Difference between the highest and lowest values in the data set.

Return Value

Position of label.