Class ValueXY

constructor

• new ValueXY(valueIn?, config?): ValueXY

• Parameters

  • Optional valueIn: {
        x: number | Value;
        y: number | Value;
    }

    • x: number | Value

    • y: number | Value

  • Optional config: null | AnimatedConfig

  Returns ValueXY

x

y

addListener

• addListener(callback): string

• Adds an asynchronous listener to the value so you can observe updates from animations. This is useful because there is no way to synchronously read the value because it might be driven natively.

  See https://reactnative.dev/docs/animatedvalue.html#addlistener

  Parameters

  • callback: ValueXYListenerCallback

  Returns string

extractOffset

• extractOffset(): void

• Returns void

flattenOffset

• flattenOffset(): void

• Returns void

getLayout

• getLayout(): {
      [key: string]: AnimatedValue;
  }

• Converts {x, y} into {left, top} for use in style, e.g.

   style={this.state.anim.getLayout()}
  Copy

  Returns {
      [key: string]: AnimatedValue;
  }

  • [key: string]: AnimatedValue

getTranslateTransform

• getTranslateTransform(): [{
      translateX: Value;
  }, {
      translateY: Value;
  }]

• Converts {x, y} into a useable translation transform, e.g.

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

  Returns [{
      translateX: Value;
  }, {
      translateY: Value;
  }]

removeListener

• removeListener(id): void

• Unregister a listener. The id param shall match the identifier previously returned by addListener().

  See https://reactnative.dev/docs/animatedvalue.html#removelistener

  Parameters

  • id: string

  Returns void

resetAnimation

• resetAnimation(callback?): void

• Parameters

  • Optional callback: ((value) => void)
    • • (value): void

      • Parameters

        • value: {
              x: number;
              y: number;
          }

          • x: number

          • y: number

        Returns void

  Returns void

setOffset

• setOffset(offset): void

• Parameters

  • offset: {
        x: number;
        y: number;
    }

    • x: number

    • y: number

  Returns void

setValue

• setValue(value): void

• Parameters

  • value: {
        x: number;
        y: number;
    }

    • x: number

    • y: number

  Returns void

stopAnimation

• stopAnimation(callback?): void

• Parameters

  • Optional callback: ((value) => void)
    • • (value): void

      • Parameters

        • value: {
              x: number;
              y: number;
          }

          • x: number

          • y: number

        Returns void

  Returns void