OverflowMode enum

Controls how content that overflows the background should be handled.

The default for DescribedFeatureOverlay is ignore.

Modes:

• ignore will render the content as is, even if it exceeds the boundaries of the background circle.
• clipContent will not render any content that is outside the background's area, i.e. clip the content. Additionally, it will pass any hit events that occur outside of the inner area to the UI below the overlay, so you do not have to worry about that.
• extendBackground will expand the background circle if necessary. The radius will be increased until the content fits within the circle's area and a padding of 4 will be added.
• wrapBackground does what extendBackground does if the content is larger than the background, but it will shrink the background if it is smaller than the content additionally. This will never be smaller than min(screenWidth, screenHeight) + 4 because the furthest point of empty content will be min(screenWidth, screenHeight) away from the center of the overlay as it is given that dimension as its width for layout reasons.

Inheritance

• Object
• Enum
• OverflowMode

Constructors

OverflowMode()

const

Values

ignore → const OverflowMode

clipContent → const OverflowMode

extendBackground → const OverflowMode

wrapBackground → const OverflowMode

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<OverflowMode>

A constant List of the values in this enum, in order of their declaration.