ViewportAnimation

Show usages

Animates changing the viewport bounds and the zoom factor for a CanvasComponent.

Inheritance Hierarchy

ViewportAnimation

Implemented Interfaces

IAnimation

Type Details

yFiles module: view

Constructors

ViewportAnimation

(canvasComponent: CanvasComponent, target: Rect, preferredDuration: TimeSpan)

Creates a new instance of ViewportAnimation.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

canvasComponent - CanvasComponent: The canvas control.
target - Rect: The target world bounds for the animation.
preferredDuration - TimeSpan: The preferred duration. One second if omitted.
considerViewportLimiter - boolean: Whether to respect the viewportLimiter of the CanvasComponent whose viewport is animated. This option sets the considerViewportLimiter property on the created object.
viewportLimitingMode - ViewportLimitingMode: The mode of the viewport limiting if considerViewportLimiter is true. This option sets the viewportLimitingMode property on the created object.
maximumTargetZoom - number: The maximum zoom level to use after the animation. This option sets the maximumTargetZoom property on the created object.
scrollBarVisibility - ScrollBarVisibility: The scroll bar visibility that will be used during the animation. This option sets the scrollBarVisibility property on the created object.
targetMargins - Insets: The margins in view coordinate dimensions to use at the target zoom level. This option sets the targetMargins property on the created object.

Properties

considerViewportLimiter

: boolean

Gets or sets whether to respect the viewportLimiter of the CanvasComponent whose viewport is animated.

Remarks

Default is false.

Property Value

true if the viewportLimiter should be considered, otherwise false.

maximumTargetZoom

: number

Gets or sets the maximum zoom level to use after the animation.

Remarks

The default is Number.POSITIVE_INFINITY.

Property Value

The maximum target zoom.

preferredDuration

: TimeSpan

Gets or sets the preferred duration of the animation.

Implements

IAnimation

scrollBarVisibility

: ScrollBarVisibility

Gets or sets the scroll bar visibility that will be used during the animation.

Property Value

The scroll bar visibility to use during animation. The default is hidden.

target

: Rect

Gets or sets the target world bounds.

targetMargins

: Insets

Gets or sets the margins in view coordinate dimensions to use at the target zoom level.

Remarks

The default is (0,0,0,0)

Property Value

The target margins in view coordinates.

viewportLimitingMode

: ViewportLimitingMode

Gets or sets the mode of the viewport limiting if considerViewportLimiter is true.

Remarks

Default is PROGRAMMATIC_NAVIGATION

Methods

animate

(time: number)

Does the animation according to the relative animation time.

Remarks

The animation starts with the time 0 and ends with time 1.

Parameters

options - Object
A map of options to pass to the method.

time - number: The animation time in [0,1].

Implements

IAnimation

applyCenterPoint

(focus: Point)

Effectively applies the center point value.

Parameters

options - Object
A map of options to pass to the method.

focus - Point: The point to set as center.

applyViewPoint

(focus: Point)

Effectively applies the viewpoint value.

Parameters

options - Object
A map of options to pass to the method.

focus - Point: The point to set the viewPoint to.

applyZoom

(value: number)

Effectively applies the zoom value.

Parameters

options - Object
A map of options to pass to the method.

value - number: The zoom value to apply.

cancel

()

Cleans up and cancels this viewport animation so that subsequent calls to animate or cleanUp won't affect the viewport anymore.

cleanUp

()

Cleans up after the animation.

Implements

IAnimation

createDelayedAnimation

(delay: TimeSpan) : IAnimation

Creates a delayed animation instance from this instance.

Remarks

The resulting animation will have a preferred duration that is delay longer than the existing one.

Parameters

options - Object
A map of options to pass to the method.

delay - TimeSpan: The delay to wait before the provided animation starts.

Returns

↪IAnimation: A new animation that will first wait before the animation starts.

Defined in

IAnimation

createEasedAnimation

(easeIn?: number, easeOut?: number) : IAnimation

Creates an eased animation for the given base animation.

Remarks

The animation speed linearly increases up to a easeIn and linearly decreases from easeOut. Between those two points, the animation speed is constant.

The duration of the ease in and ease out is determined by a mapping [0,1] → [0,1]. The mapping has to be increasing to preserve the order of the frames in the decorated animation. In general, we consider continuously differentiable functions f where integral of f′ equals 1 a suitable choice for the mapping.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

easeIn - number: The ratio for the ease-in time [0,1] where 0 is the start of the animation and 1 the end. 0.5 is the default value.
easeOut - number: The ratio for the ease-out time [0,1] where 0 is the start of the animation and 1 the end. 0.5 is the default value.

Returns

↪IAnimation: The newly created IAnimation.

Defined in

IAnimation

initialize

()

Initializes this animation.

Remarks

This has to be called once before any calls to animate. An instance of ViewportAnimation can be reused after an animation by setting new target or a new preferredDuration and calling Initialize() again.

Implements

IAnimation