Interface IProjectionNode<I>

interface IProjectionNode<I> {
    animationId: number;
    animationValues?: ResolvedValues;
    children: Set<IProjectionNode<unknown>>;
    currentAnimation?: AnimationPlaybackControls;
    depth: number;
    hasTreeAnimated: boolean;
    id: number;
    instance: I;
    isAnimationBlocked?: boolean;
    isLayoutDirty: boolean;
    isPresent?: boolean;
    isProjectionDirty: boolean;
    isSharedProjectionDirty: boolean;
    isTransformDirty: boolean;
    isTreeAnimating?: boolean;
    isTreeAnimationBlocked: (() => boolean);
    isUpdating: boolean;
    isVisible: boolean;
    latestValues: ResolvedValues;
    layout?: Measurements;
    mount: ((node, isLayoutDirty?) => void);
    needsReset: boolean;
    nodes?: FlatTree;
    options: ProjectionNodeOptions;
    parent?: IProjectionNode<unknown>;
    path: IProjectionNode<unknown>[];
    preserveOpacity?: boolean;
    prevTransformTemplateValue: undefined | string;
    projectionDelta?: Delta;
    projectionDeltaWithTransform?: Delta;
    relativeParent?: IProjectionNode<unknown>;
    relativeTarget?: Framer.Box;
    relativeTargetOrigin?: Framer.Box;
    resolvedRelativeTargetAt?: number;
    resumeFrom?: IProjectionNode<unknown>;
    resumingFrom?: IProjectionNode<unknown>;
    root?: IProjectionNode<unknown>;
    scroll?: ScrollMeasurements;
    sharedNodes: Map<string, NodeStack>;
    shouldResetTransform: boolean;
    snapshot?: Measurements;
    target?: Framer.Box;
    targetDelta?: Delta;
    targetWithTransforms?: Framer.Box;
    treeScale?: Point;
    unmount: (() => void);
    updateBlockedByResize: boolean;
    updateManuallyBlocked: boolean;
    addEventListener(name, handler): VoidFunction;
    applyTransform(box, transformOnly?): Framer.Box;
    blockUpdate(): void;
    calcProjection(): void;
    checkUpdateFailed(): void;
    clearMeasurements(): void;
    clearSnapshot(): void;
    didUpdate(): void;
    finishAnimation(): void;
    getClosestProjectingParent(): undefined | IProjectionNode<unknown>;
    getProjectionStyles(styles?): undefined | MotionStyle;
    getStack(): undefined | NodeStack;
    hasListeners(name): boolean;
    hide(): void;
    isLead(): boolean;
    isProjecting(): boolean;
    isUpdateBlocked(): boolean;
    measure(removeTransform?): Measurements;
    measurePageBox(): Framer.Box;
    notifyListeners(name, ...args): void;
    promote(options?): void;
    registerSharedNode(id, node): void;
    relegate(): boolean;
    resetRotation(): void;
    resetTransform(): void;
    resetTree(): void;
    resolveTargetDelta(force?): void;
    scheduleCheckAfterUnmount(): void;
    scheduleRender(notifyAll?): void;
    scheduleUpdateProjection(): void;
    setAnimationOrigin(delta): void;
    setOptions(options): void;
    setTargetDelta(delta): void;
    show(): void;
    startAnimation(transition): void;
    startUpdate(): void;
    unblockUpdate(): void;
    updateLayout(): void;
    updateScroll(phase?): void;
    updateSnapshot(): void;
    willUpdate(notifyListeners?): void;
}

Type Parameters

  • I = unknown

Properties

animationId animationValues? children currentAnimation? depth hasTreeAnimated id instance isAnimationBlocked? isLayoutDirty isPresent? isProjectionDirty isSharedProjectionDirty isTransformDirty isTreeAnimating? isTreeAnimationBlocked isUpdating isVisible latestValues layout? mount needsReset nodes? options parent? path preserveOpacity? prevTransformTemplateValue projectionDelta? projectionDeltaWithTransform? relativeParent? relativeTarget? relativeTargetOrigin? resolvedRelativeTargetAt? resumeFrom? resumingFrom? root? scroll? sharedNodes shouldResetTransform snapshot? target? targetDelta? targetWithTransforms? treeScale? unmount updateBlockedByResize updateManuallyBlocked

Methods

addEventListener applyTransform blockUpdate calcProjection checkUpdateFailed clearMeasurements clearSnapshot didUpdate finishAnimation getClosestProjectingParent getProjectionStyles getStack hasListeners hide isLead isProjecting isUpdateBlocked measure measurePageBox notifyListeners promote registerSharedNode relegate resetRotation resetTransform resetTree resolveTargetDelta scheduleCheckAfterUnmount scheduleRender scheduleUpdateProjection setAnimationOrigin setOptions setTargetDelta show startAnimation startUpdate unblockUpdate updateLayout updateScroll updateSnapshot willUpdate

Properties

animationId

animationId: number

Optional animationValues

animationValues?: ResolvedValues

children

children: Set<IProjectionNode<unknown>>

Optional currentAnimation

currentAnimation?: AnimationPlaybackControls

depth

depth: number

hasTreeAnimated

hasTreeAnimated: boolean

id

id: number

instance

instance: I

Optional isAnimationBlocked

isAnimationBlocked?: boolean

isLayoutDirty

isLayoutDirty: boolean

Optional isPresent

isPresent?: boolean

isProjectionDirty

isProjectionDirty: boolean

isSharedProjectionDirty

isSharedProjectionDirty: boolean

isTransformDirty

isTransformDirty: boolean

Optional isTreeAnimating

isTreeAnimating?: boolean

isTreeAnimationBlocked

isTreeAnimationBlocked: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

isUpdating

isUpdating: boolean

isVisible

isVisible: boolean

latestValues

latestValues: ResolvedValues

Optional layout

layout?: Measurements

mount

mount: ((node, isLayoutDirty?) => void)

Type declaration

    • (node, isLayoutDirty?): void

    • Parameters

      • node: I
      • Optional isLayoutDirty: boolean

      Returns void

needsReset

needsReset: boolean

Optional nodes

nodes?: FlatTree

options

options: ProjectionNodeOptions

Optional parent

parent?: IProjectionNode<unknown>

path

path: IProjectionNode<unknown>[]

Optional preserveOpacity

preserveOpacity?: boolean

prevTransformTemplateValue

prevTransformTemplateValue: undefined | string

Optional projectionDelta

projectionDelta?: Delta

Optional projectionDeltaWithTransform

projectionDeltaWithTransform?: Delta

Optional relativeParent

relativeParent?: IProjectionNode<unknown>

Optional relativeTarget

relativeTarget?: Framer.Box

Optional relativeTargetOrigin

relativeTargetOrigin?: Framer.Box

Optional resolvedRelativeTargetAt

resolvedRelativeTargetAt?: number

Optional resumeFrom

resumeFrom?: IProjectionNode<unknown>

Optional resumingFrom

resumingFrom?: IProjectionNode<unknown>

Optional root

root?: IProjectionNode<unknown>

Optional scroll

scroll?: ScrollMeasurements

sharedNodes

sharedNodes: Map<string, NodeStack>

shouldResetTransform

shouldResetTransform: boolean

Optional snapshot

snapshot?: Measurements

Optional target

target?: Framer.Box

Optional targetDelta

targetDelta?: Delta

Optional targetWithTransforms

targetWithTransforms?: Framer.Box

Optional treeScale

treeScale?: Point

unmount

unmount: (() => void)

Type declaration

    • (): void

    • Returns void

updateBlockedByResize

updateBlockedByResize: boolean

updateManuallyBlocked

updateManuallyBlocked: boolean

Methods

addEventListener

  • addEventListener(name, handler): VoidFunction

  • Parameters

    • name: LayoutEvents
    • handler: any

    Returns VoidFunction

applyTransform

  • applyTransform(box, transformOnly?): Framer.Box

  • Parameters

    • box: Framer.Box
    • Optional transformOnly: boolean

    Returns Framer.Box

blockUpdate

  • blockUpdate(): void

  • Returns void

calcProjection

  • calcProjection(): void

  • Returns void

checkUpdateFailed

  • checkUpdateFailed(): void

  • Returns void

clearMeasurements

  • clearMeasurements(): void

  • Returns void

clearSnapshot

  • clearSnapshot(): void

  • Returns void

didUpdate

  • didUpdate(): void

  • Returns void

finishAnimation

  • finishAnimation(): void

  • Returns void

getClosestProjectingParent

  • getClosestProjectingParent(): undefined | IProjectionNode<unknown>

  • Returns undefined | IProjectionNode<unknown>

getProjectionStyles

  • getProjectionStyles(styles?): undefined | MotionStyle

  • Parameters

    Returns undefined | MotionStyle

getStack

  • getStack(): undefined | NodeStack

  • Returns undefined | NodeStack

hasListeners

  • hasListeners(name): boolean

  • Parameters

    • name: LayoutEvents

    Returns boolean

hide

  • hide(): void

  • Returns void

isLead

  • isLead(): boolean

  • Returns boolean

isProjecting

  • isProjecting(): boolean

  • Returns boolean

isUpdateBlocked

  • isUpdateBlocked(): boolean

  • Returns boolean

measure

  • measure(removeTransform?): Measurements

  • Parameters

    • Optional removeTransform: boolean

    Returns Measurements

measurePageBox

  • measurePageBox(): Framer.Box

  • Returns Framer.Box

notifyListeners

  • notifyListeners(name, ...args): void

  • Parameters

    • name: LayoutEvents
    • Rest ...args: any

    Returns void

promote

  • promote(options?): void

  • Parameters

    • Optional options: {
          needsReset?: boolean;
          preserveFollowOpacity?: boolean;
          transition?: Transition;
      }
      • Optional needsReset?: boolean
      • Optional preserveFollowOpacity?: boolean
      • Optional transition?: Transition

    Returns void

registerSharedNode

  • registerSharedNode(id, node): void

  • Parameters

    Returns void

relegate

  • relegate(): boolean

  • Returns boolean

resetRotation

  • resetRotation(): void

  • Returns void

resetTransform

  • resetTransform(): void

  • Returns void

resetTree

  • resetTree(): void

  • Returns void

resolveTargetDelta

  • resolveTargetDelta(force?): void

  • Parameters

    • Optional force: boolean

    Returns void

scheduleCheckAfterUnmount

  • scheduleCheckAfterUnmount(): void

  • Returns void

scheduleRender

  • scheduleRender(notifyAll?): void

  • Parameters

    • Optional notifyAll: boolean

    Returns void

scheduleUpdateProjection

  • scheduleUpdateProjection(): void

  • Returns void

setAnimationOrigin

  • setAnimationOrigin(delta): void

  • Parameters

    Returns void

setOptions

  • setOptions(options): void

  • Parameters

    • options: ProjectionNodeOptions

    Returns void

setTargetDelta

  • setTargetDelta(delta): void

  • Parameters

    Returns void

show

  • show(): void

  • Returns void

startAnimation

  • startAnimation(transition): void

  • Parameters

    Returns void

startUpdate

  • startUpdate(): void

  • Returns void

unblockUpdate

  • unblockUpdate(): void

  • Returns void

updateLayout

  • updateLayout(): void

  • Returns void

updateScroll

  • updateScroll(phase?): void

  • Parameters

    • Optional phase: Phase

    Returns void

updateSnapshot

  • updateSnapshot(): void

  • Returns void

willUpdate

  • willUpdate(notifyListeners?): void

  • Parameters

    • Optional notifyListeners: boolean

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc