Instance Method

routeButtonImage(for:)

Returns the button image associated with the specified control state.

Declaration

func routeButtonImage(for state: UIControl.State) -> UIImage?

Parameters

state

The control state whose thumb image you want. You should specify only one control state value for this parameter.

Return Value

The button image associated with the specified state, or nil if an appropriate image could not be retrieved. This method might return nil if you specify multiple control states in the state parameter.

Discussion

Use this method to retrieve the corresponding button image for a specific state.

See Also

Customizing the Route Button

func routeButtonRect(forBounds: CGRect) -> CGRect

Returns the drawing rectangle for the route button.

Deprecated
func setRouteButtonImage(UIImage?, for: UIControl.State)

Assigns a button image to the specified control states.

Deprecated