iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

Other Functions

The following functions are available globally.




SCIApplyAlignmentInternal

Apply a SCIAlighnment constant to an object.

Warning

This function is desined for initernal use only.

Declaration

Objective-C

static inline CGRect SCIApplyAlignmentInternal(SCIAlignment alignment,
                                               CGFloat w, CGFloat h,
                                               CGFloat xAdj, CGFloat yAdj,
                                               CGRect container)

Swift

func SCIApplyAlignmentInternal(_ alignment: SCIAlignment, _ w: CGFloat, _ h: CGFloat, _ xAdj: CGFloat, _ yAdj: CGFloat, _ container: CGRect) -> CGRect

Parameters

`alignment`	The desired placement of the object, as defined by the SCIAlignment constants.
`w`	The horizontal size of the object.
`h`	The vertical size of the object.
`container`	The frame of the containing space, in which the object will be placed. Should be large enough to contain the width and height of the object.
`xAdj`	Offset to apply to the X axis.
`yAdj`	Offset to apply to the Y axis.

Return Value

The computed frame of the object in its container.




SCIApplyAlignmentWH

Apply a SCIAlighnment constant to an object.

Warning

This function is desined for initernal use only.

Declaration

Objective-C

static inline CGRect SCIApplyAlignmentWH(SCIAlignment alignment, CGFloat w,
                                         CGFloat h, CGRect container)

Swift

func SCIApplyAlignmentWH(_ alignment: SCIAlignment, _ w: CGFloat, _ h: CGFloat, _ container: CGRect) -> CGRect

Parameters

`alignment`	The desired placement of the object, as defined by the SCIAlignment constants.
`w`	The horizontal size of the object.
`h`	The vertical size of the object.
`container`	The frame of the containing space, in which the object will be placed. Should be large enough to contain the width and height of the object.

Return Value

The computed frame of the object in its container.




SCIApplyAlignment

Apply a SCIAlighnment constant to an object.

Warning

This function is desined for initernal use only.

Declaration

Objective-C

static inline CGRect SCIApplyAlignment(SCIAlignment alignment, CGSize size,
                                       CGRect container)

Swift

func SCIApplyAlignment(_ alignment: SCIAlignment, _ size: CGSize, _ container: CGRect) -> CGRect

Parameters

`alignment`	The desired placement of the object, as defined by the `SCIAlignment` constants.
`size`	The size of the object.
`container`	The frame of the containing space, in which the object will be placed. Should be large enough to contain the width and height of the object.

Return Value

The computed frame of the object in its container.




SCICalculateFrameWithAlignment

Calculates the frame of the object in its container.

Warning

This function is desined for initernal use only.

Declaration

Objective-C

static inline CGRect SCICalculateFrameWithAlignment(SCIAlignment alignment,
                                                    CGPoint point, CGSize size,
                                                    CGRect container,
                                                    _Bool isLeft, _Bool isTop)

Swift

func SCICalculateFrameWithAlignment(_ alignment: SCIAlignment, _ point: CGPoint, _ size: CGSize, _ container: CGRect, _ isLeft: Bool, _ isTop: Bool) -> CGRect

Parameters

`alignment`	The desired placement of the object, relative to `point`, as defined by the SCIAlignment constants.
`point`	The point relative to which object will be placed.
`size`	The size of the object.
`container`	The frame of the containing space, in which the object will be placed. Should be large enough to contain the width and height of the object.

Return Value

The computed frame of the object in its container.