Symbols · IOS API REFERENCE

VariableColorSymbolEffect

struct · iOS 17.0+ · SDK 27.1

struct VariableColorSymbolEffect

A symbol effect that applies the Variable Color animation to symbol images. The Variable Color animation replaces the opacity of variable layers in the symbol by a possibly repeating pattern that moves up and possibly back down the variable layers. It has no effect for non-variable color symbol images.

Members (7)

get · iOS 17.0+

cumulative

TypeScript

get cumulative(): VariableColorSymbolEffect

Swift declaration

var cumulative: VariableColorSymbolEffect { get }

Returns a copy of the effect requesting that the Variable Color animation applies its Cumulative variant, where each sucessive variable layer is enabled and stays enabled until the end of the animation cycle. This cancels the `iterative` variant.

get · iOS 17.0+

nonReversing

TypeScript

get nonReversing(): VariableColorSymbolEffect

Swift declaration

var nonReversing: VariableColorSymbolEffect { get }

Returns a copy of the effect requesting that the Variable Color animation not play in reverse each time it repeats.

get · iOS 17.0+

configuration

TypeScript

get configuration(): SymbolEffectConfiguration

Swift declaration

var configuration: SymbolEffectConfiguration { get }

The configuration for the effect.

get · iOS 17.0+

dimInactiveLayers

TypeScript

get dimInactiveLayers(): VariableColorSymbolEffect

Swift declaration

var dimInactiveLayers: VariableColorSymbolEffect { get }

Returns a copy of the effect requesting that the Variable Color animation draw inactive layers with reduced (but non-zero) opacity.

get · iOS 17.0+

hideInactiveLayers

TypeScript

get hideInactiveLayers(): VariableColorSymbolEffect

Swift declaration

var hideInactiveLayers: VariableColorSymbolEffect { get }

Returns a copy of the effect requesting that the Variable Color animation hide inactive layers completely, rather than drawing with reduced (but non-zero) opacity.

get · iOS 17.0+

iterative

TypeScript

get iterative(): VariableColorSymbolEffect

Swift declaration

var iterative: VariableColorSymbolEffect { get }

Returns a copy of the effect requesting that the Variable Color animation applies its Iterative variant, where each sucessive variable layer is active for a short period of time and then inactive until the animation cycle repeats. This cancels the `cumulative` variant.

get · iOS 17.0+

reversing

TypeScript

get reversing(): VariableColorSymbolEffect

Swift declaration

var reversing: VariableColorSymbolEffect { get }

Returns a copy of the effect requesting that the Variable Color animation play in reverse each time it repeats.

Skipped declarations

No declarations were skipped in this snapshot.

All Symbols types →