Instance Method

animation(forKey:)

Returns the animation object with the specified identifier.

Declaration

func animation(forKey key: String) -> CAAnimation?

Parameters

key

A string that specifies the identifier of the animation. This string corresponds to the identifier string you passed to the add(_:forKey:) method.

Return Value

The animation object matching the identifier, or nil if no such animation exists.

Discussion

You can use this string to retrieve animation objects already associated with a layer. However, you must not modify any properties of the returned object. Doing so will result in undefined behavior.

See Also

Layer Animations

func add(CAAnimation, forKey: String?)

Add the specified animation object to the layer’s render tree.

func removeAllAnimations()

Remove all animations attached to the layer.

func removeAnimation(forKey: String)

Remove the animation object with the specified key.

func animationKeys() -> [String]?

Returns an array of strings that identify the animations currently attached to the layer.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software