Viewer object

app.activeViewer

Description

The Viewer object represents a Composition, Layer, or Footage panel.

Example

This maximizes the active viewer panel, and displays its type if it contains a composition.

var activeViewer = app.activeViewer;
activeViewer.maximized = true;
if (activeViewer.type === ViewerType.VIEWER_COMPOSITION) {
    alert("Composition panel is active.");
}

Attributes

Viewer.active

viewer.active

Description

When true, indicates if the viewer panel is focused, and thereby frontmost.

Type

Boolean; read-only.

Viewer.fastPreview

viewer.fastPreview

Description

The state of the Fast Previews menuThis is a read/write attribute using an enumerated value:

Warning

If you try to get or set the attribute’s value in the Layer or Footage panel, you’ll get an error message.

Note

The Draft preview mode is only available in ray-traced 3D compositions. If you try to use it in a Classic 3D composition, you’ll get an error: “Cannot set Draft fast preview mode in a Classic 3D composition.”

Type

A FastPreviewType enumerated value; read/write. One of:

  • FastPreviewType.FP_OFF: Off (Final Quality)
  • FastPreviewType.FP_ADAPTIVE_RESOLUTION: Adaptive Resolution
  • FastPreviewType.FP_DRAFT: Draft
  • FastPreviewType.FP_FAST_DRAFT: Fast Draft
  • FastPreviewType.FP_WIREFRAME: Wireframe

Example

app.activeViewer.views[0].options.fastPreview === FastPreviewType.FP_ADAPTIVE_RESOLUTION;
app.activeViewer.views[0].options.fastPreview === FastPreviewType.FP_DRAFT;
app.activeViewer.views[0].options.fastPreview === FastPreviewType.FP_FAST_DRAFT;
app.activeViewer.views[0].options.fastPreview === FastPreviewType.FP_OFF;
app.activeViewer.views[0].options.fastPreview === FastPreviewType.FP_WIREFRAME;

Viewer.guidesLocked

viewer.guidesLocked

Note

This functionality was added in After Effects 16.1 (CC 2019)

Description

When true, indicates guides are locked in the viewer.

Type

Boolean; read/write.

Example

app.activeViewer.views[0].options.guidesLocked;

Viewer.guidesSnap

viewer.guidesSnap

Note

This functionality was added in After Effects 16.1 (CC 2019)

Description

When true, indicates layers snap to guides when dragged in the viewer.

Type

Boolean; read/write.

Example

app.activeViewer.views[0].options.guidesSnap;

Viewer.guidesVisibility

viewer.guidesVisibility

Note

This functionality was added in After Effects 16.1 (CC 2019)

Description

When true, indicates guides are visible in the viewer.

Type

Boolean; read/write.

Example

app.activeViewer.views[0].options.guidesVisibility;

Viewer.maximized

viewer.maximized

Description

When true, indicates if the viewer panel is at its maximized size.

Type

Boolean; read/write.

Viewer.rulers

viewer.rulers

Note

This functionality was added in After Effects 16.1 (CC 2019)

Description

When true, indicates rulers are shown in the viewer.

Type

Boolean; read/write.

Example

app.activeViewer.views[0].options.rulers;

Viewer.type

viewer.type

Description

The content in the viewer panel.

Type

A ViewerType enumerated value; read-only. One of:

  • ViewerType.VIEWER_COMPOSITION
  • ViewerType.VIEWER_LAYER
  • ViewerType.VIEWER_FOOTAGE

Methods

Viewer.setActive()

viewer.setActive()

Description

Moves the viewer panel to the front and places focus on it, making it active. Calling this method will set the viewer’s active attribute to true.

Parameters

None.

Returns

Boolean indicating if the viewer panel was made active.