View options

ViewOptions ¶

The ViewOptions object represents the options for a given View object.

Example

from py_aep import parse

app = parse("project.aep")
options = app.active_viewer.views[0].options
print(options.zoom)

See: https://ae-scripting.docsforadobe.dev/other/viewoptions/

Attributes¶

channels ¶

channels = enum(ChannelType, '_fips', 'channels')

The state of the Channels menu. Read / Write.

checkerboards ¶

checkerboards = bool('_fips', 'checkerboards')

When True, checkerboards (transparency grid) is enabled in the current view. Read / Write.

draft3d ¶

draft3d = bool('_fips', 'draft3d')

When True, Draft 3D mode is enabled for the Composition panel. This corresponds to the value of the Draft 3D button in the Composition panel. Read / Write.

exposure ¶

exposure = ChunkField[float](
    "_fips",
    "exposure",
    validate=validate_number(min=-40.0, max=40.0),
)

The exposure value for the current view. Read / Write.

fast_preview ¶

fast_preview = enum(
    FastPreviewType,
    "_fips",
    "fast_preview_type",
    reverse_instance_field=_reverse_fast_preview,
)

The state of the Fast Previews menu. Read / Write.

grid ¶

grid = bool('_fips', 'grid')

When True, the grid overlay is visible in the view. Read / Write.

guides_locked ¶

guides_locked = bool('_fips', 'guides_locked')

When True, indicates guides are locked in the view. Read / Write.

guides_snap ¶

guides_snap = bool('_fips', 'guides_snap')

When True, indicates layers snap to guides when dragged in the view. Read / Write.

guides_visibility ¶

guides_visibility = bool('_fips', 'guides_visibility')

When True, indicates guides are visible in the view. Read / Write.

mask_and_shape_path ¶

mask_and_shape_path = bool('_fips', 'mask_and_shape_path')

When True, indicates mask and shape paths are visible in the view. Read / Write.

proportional_grid ¶

proportional_grid = bool('_fips', 'proportional_grid')

When True, indicates the proportional grid overlay is visible in the view. Read / Write.

region_of_interest ¶

region_of_interest = bool('_fips', 'region_of_interest')

When True, the region of interest (ROI) selection is active in the view. Read / Write.

roi_bottom ¶

roi_bottom = ChunkField[int](
    "_fips",
    "roi_bottom",
    validate=validate_number(
        min=lambda self: roi_top + 1,
        max=lambda self: height if _item else None,
        integer=True,
    ),
)

Bottom coordinate of the region of interest in pixels. Read / Write.

roi_left ¶

roi_left = ChunkField[int](
    "_fips",
    "roi_left",
    validate=validate_number(
        min=0, max=lambda self: roi_right - 1, integer=True
    ),
)

Left coordinate of the region of interest in pixels. Read / Write.

roi_right ¶

roi_right = ChunkField[int](
    "_fips",
    "roi_right",
    validate=validate_number(
        min=lambda self: roi_left + 1,
        max=lambda self: width if _item else None,
        integer=True,
    ),
)

Right coordinate of the region of interest in pixels. Read / Write.

roi_top ¶

roi_top = ChunkField[int](
    "_fips",
    "roi_top",
    validate=validate_number(
        min=0, max=lambda self: roi_bottom - 1, integer=True
    ),
)

Top coordinate of the region of interest in pixels. Read / Write.

rulers ¶

rulers = bool('_fips', 'rulers')

When True, indicates rulers are shown in the view. Read / Write.

title_action_safe ¶

title_action_safe = bool('_fips', 'title_action_safe')

When True, indicates title/action safe margin guides are visible in the view. Read / Write.

use_display_color_management ¶

use_display_color_management = bool(
    "_fips", "use_display_color_management"
)

When True, indicates display color management is enabled for the view. Read / Write.

zoom ¶

zoom = ChunkField[float](
    "_fips",
    "zoom",
    validate=validate_number(min=0.01, max=16.0),
)

The current zoom value for the view, as a normalized percentage between 1% (0.01) and 1600% (16). Read / Write.