Instance Method

backgroundImage(for:barMetrics:)

Returns the background image to use for a given bar position and set of metrics.

Declaration

func backgroundImage(for barPosition: UIBarPosition, barMetrics: UIBarMetrics) -> UIImage?

Parameters

barPosition

The location of the navigation bar.

barMetrics

The metrics of the navigation bar.

Return Value

The image to use for the specified location and metrics.

Discussion

Resizable images will be stretched vertically, if necessary, for a position of UIBarPosition.topAttached.

See Also

Changing the Background

var barTintColor: UIColor?

The tint color to apply to the navigation bar background.

func backgroundImage(for: UIBarMetrics) -> UIImage?

Returns the background image for given bar metrics.

func setBackgroundImage(UIImage?, for: UIBarMetrics)

Sets the background image for given bar metrics.

func setBackgroundImage(UIImage?, for: UIBarPosition, barMetrics: UIBarMetrics)

Sets the background image to use for a given bar position and set of metrics.