PullToRefreshSettings class

Pull-To-Refresh Settings for PlatformPullToRefreshController.

Officially Supported Platforms/Implementations:

  • Android WebView
  • iOS WKWebView
  • Windows WebView2

Constructors

PullToRefreshSettings({bool? allowWithNoScrollbar = false, AttributedString? attributedTitle, Color? backgroundColor, Color? color, int? distanceToTriggerSync, bool? enabled = true, PullToRefreshSize? size, int? slingshotDistance})
Officially Supported Platforms/Implementations:

Properties

allowWithNoScrollbar ↔ bool?
Allows pull-to-refresh to start when the document has no vertical scrollbar.
getter/setter pair
attributedTitle ↔ AttributedString?
The title text to display in the refresh control.
getter/setter pair
backgroundColor ↔ Color?
The background color of the refresh control.
getter/setter pair
color ↔ Color?
The color of the refresh control.
getter/setter pair
distanceToTriggerSync ↔ int?
The distance to trigger a sync in dips.
getter/setter pair
enabled ↔ bool?
Sets whether the pull-to-refresh feature is enabled or not. The default value is true.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size ↔ PullToRefreshSize?
The size of the refresh indicator.
getter/setter pair
slingshotDistance ↔ int?
The distance in pixels that the refresh indicator can be pulled beyond its resting position.
getter/setter pair

Methods

copy() → PullToRefreshSettings
Returns a copy of PullToRefreshSettings.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts instance to a map.
toMap({EnumMethod? enumMethod}) → Map<String, dynamic>
Converts instance to a map.
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromMap(Map<String, dynamic>? map, {EnumMethod? enumMethod}) → PullToRefreshSettings?
Gets a possible PullToRefreshSettings instance from a Map value.
isPropertySupported(PullToRefreshSettingsProperty property, {TargetPlatform? platform}) → bool
Check if the given property is supported by the defaultTargetPlatform or a specific platform.