跳到主要内容

Animated.ValueXY

用于驱动二维动画(例如平移手势)的二维值。API 几乎与普通的 Animated.Value 完全相同,但经过多路复用。底层包含两个常规的 Animated.Value

示例


参考

方法

setValue()

React TSX
setValue(value: {x: number; y: number});

直接设置值。这将停止当前在该值上运行的任何动画,并更新所有绑定的属性。

参数:

名称类型必填描述
value{x: number; y: number}

setOffset()

React TSX
setOffset(offset: {x: number; y: number});

设置一个偏移量,该偏移量会应用于已设置的任何值之上,无论该值是通过 setValue、动画还是 Animated.event 设置的。适用于补偿平移手势开始位置等情况。

参数:

名称类型必填描述
offset{x: number; y: number}偏移值

flattenOffset()

React TSX
flattenOffset();

将偏移值合并到基础值中,并将偏移量重置为零。该值的最终输出保持不变。


extractOffset()

React TSX
extractOffset();

将基础值设置为偏移值,并将基础值重置为零。该值的最终输出保持不变。


addListener()

React TSX
addListener(callback: (value: {x: number; y: number}) => void);

向该值添加一个异步监听器,以便观察动画的更新。当该值可能由原生代码驱动时,无法同步读取它,因此此方法非常有用。

返回一个用作监听器标识符的字符串。

参数:

名称类型必填描述
callbackfunction回调函数,该函数将接收一个对象,其中的 value 键被设置为新值。

removeListener()

React TSX
removeListener(id: string);

注销一个监听器。id 参数应与之前由 addListener() 返回的标识符匹配。

参数:

名称类型必填描述
idstring要移除的监听器的 ID。

removeAllListeners()

React TSX
removeAllListeners();

移除所有已注册的监听器。


stopAnimation()

React TSX
stopAnimation(callback?: (value: {x: number; y: number}) => void);

停止任何正在运行的动画或跟踪。停止动画后,会使用最终值调用 callback,这对于更新状态以使布局与动画位置保持一致非常有用。

参数:

名称类型必填描述
callbackfunction接收最终值的函数。

resetAnimation()

React TSX
resetAnimation(callback?: (value: {x: number; y: number}) => void);

停止任何动画,并将值重置为其初始值。

参数:

名称类型必填描述
callbackfunction接收初始值的函数。

getLayout()

React TSX
getLayout(): {left: Animated.Value, top: Animated.Value};

{x, y} 转换为 {left, top},以便在样式中使用,例如

React TSX
style={this.state.anim.getLayout()}

getTranslateTransform()

React TSX
getTranslateTransform(): [
{translateX: Animated.Value},
{translateY: Animated.Value},
];

{x, y} 转换为可用的平移变换,例如

React TSX
style={{
transform: this.state.anim.getTranslateTransform()
}}