One Logo Pool Ball
X
Github
Discord

System

Symbols · IOS API REFERENCE

SymbolEffectOptions

struct · iOS 17.0+ · SDK 27.1

struct SymbolEffectOptions

Options configuring how symbol effects apply to symbol views.

Members (11)

get · iOS 17.0+

nonRepeating

TypeScript
get nonRepeating(): SymbolEffectOptions
Swift declaration
var nonRepeating: SymbolEffectOptions { get }

Returns a copy of the options that prefers not to repeat.

get · iOS 17.0+

nonRepeating

TypeScript
static get nonRepeating3194(): SymbolEffectOptions
Swift declaration
static var nonRepeating: SymbolEffectOptions { get }

A set of symbol effect options that prefers not to repeat.

method · iOS 17.0+

speed

TypeScript
speed(speed: number): SymbolEffectOptions
Swift declaration
func speed(_ speed: Double) -> SymbolEffectOptions

Sets the preferred speed multiplier of a set of symbol effect options. - Parameter speed: The preferred speed multiplier to play the effect with. The default multiplier is `1.0`. Very large or small values may be clamped. - Returns: A new set of symbol effect options with the preferred speed multiplier.

static · iOS 17.0+

speed

TypeScript
static speed7257(speed: number): SymbolEffectOptions
Swift declaration
static func speed(_ speed: Double) -> SymbolEffectOptions

Creates a set of symbol effect options with a preferred speed multiplier. - Parameter speed: The preferred speed multiplier to play the effect with. The default multiplier is `1.0`. Very large or small values may be clamped. - Returns: A new set of symbol effect options with the preferred speed multiplier.

method · iOS 18.0+

repeat

TypeScript
repeat(behavior: SymbolEffectOptions_RepeatBehavior): SymbolEffectOptions
Swift declaration
func `repeat`(_ behavior: SymbolEffectOptions.RepeatBehavior) -> SymbolEffectOptions

Creates a set of symbol effect options that repeats with a preferred behavior. - Parameter behavior: The preferred behavior when the effect is repeated. - Returns: A new set of symbol effect options with the preferred repeat behavior.

static · iOS 18.0+

repeat

TypeScript
static repeat32339(behavior: SymbolEffectOptions_RepeatBehavior): SymbolEffectOptions
Swift declaration
static func `repeat`(_ behavior: SymbolEffectOptions.RepeatBehavior) -> SymbolEffectOptions

Sets the preferred repeat behavior. - Parameter behavior: The preferred behavior when the effect is repeated. - Returns: A new set of symbol effect options with the preferred repeat behavior.

method · iOS 17.0+ · Deprecated in iOS 100000.0

repeat

TypeScript
repeat96399(count?: (number) | null): SymbolEffectOptions
Swift declaration
func `repeat`(_ count: Int?) -> SymbolEffectOptions

Sets the preferred number of times to play the effect. - Parameter count: The preferred number of times to play the effect, or nil to request the default number of repeats. Very large or small values may be clamped. - Returns: A new set of symbol effect options with the preferred repeat count.

static · iOS 17.0+ · Deprecated in iOS 100000.0

repeat

TypeScript
static repeat8111(count?: (number) | null): SymbolEffectOptions
Swift declaration
static func `repeat`(_ count: Int?) -> SymbolEffectOptions

Creates a set of symbol effect options with a preferred repeat count. - Parameter count: The preferred number of times to play the effect, or nil to request the default number of repeats. Very large or small values may be clamped. - Returns: A new set of symbol effect options with the preferred repeat count.

get · iOS 17.0+

default

TypeScript
static get default(): SymbolEffectOptions
Swift declaration
static var `default`: SymbolEffectOptions { get }

The default set of symbol effect options.

get · iOS 17.0+ · Deprecated in iOS 100000.0

repeating

TypeScript
get repeating(): SymbolEffectOptions
Swift declaration
var repeating: SymbolEffectOptions { get }

Returns a copy of the options that prefers to repeat indefinitely.

get · iOS 17.0+ · Deprecated in iOS 100000.0

repeating

TypeScript
static get repeating64259(): SymbolEffectOptions
Swift declaration
static var repeating: SymbolEffectOptions { get }

A set of symbol effect options that prefers to repeat indefinitely.

Skipped declarations

No declarations were skipped in this snapshot.

All Symbols types →