Alignment Grid
Alignment Grid operator properties for Script Engine. Draws a configurable grid or crosshair overlay on top of the layer. Useful for composing shots, lining up graphics or lower-thirds against safe areas, checking that text is on a baseline, and verifying that on-air elements are placed consistently across scenes. Has no effect on the rendered output once disabled or set to a fully transparent opacity.
| Property | Type | Access | Description |
|---|---|---|---|
Grid |
GridLayout |
get/set |
Which overlay pattern to draw. [default=Crosshair]. Crosshair draws a single pair of centre lines — minimal but enough to confirm dead-centre placement. Grid4x4 and Grid8x8 lay out an evenly spaced grid for more detailed layout work. |
Opacity |
int |
get/set |
Transparency of the grid overlay, 0–100. [default=100]. 0 hides the grid; 100 makes it fully opaque. Lower values let the underlying image show through — useful when you want the grid as a faint reference rather than a dominant element on screen. |
ColorR |
int |
get/set |
Red component of the grid line colour, 0–255. Combined with ColorG and ColorB to set the line tint. Hidden in the UI in favour of ColorPicker, but available to scripts. |
ColorG |
int |
get/set |
Green component of the grid line colour, 0–255. |
ColorB |
int |
get/set |
Blue component of the grid line colour, 0–255. |
ColorPicker |
AdvancedColorPicker |
get/set |
Combined colour picker for the grid lines. Convenience UI wrapper around ColorR, ColorG, and ColorB. Default is white, which gives the highest contrast against most footage. |
ResetColorCmd |
Command |
get |
Reset the grid colour and opacity to their defaults (white, fully opaque). |
GridOffsetX |
int |
get/set |
Horizontal offset of the grid centre, in pixels. [min=-1920, max=1920, default=0]. 0 keeps the grid centred on the layer. Positive shifts right, negative shifts left. Useful when matching a grid to a non-centred element in the composition. |
GridOffsetY |
int |
get/set |
Vertical offset of the grid centre, in pixels. [min=-1080, max=1080, default=0]. 0 keeps the grid centred. Positive shifts down, negative shifts up. |
GridThickness |
int |
get/set |
Width of the grid lines, in pixels. [min=1, max=10, default=1]. 1 draws hairline reference lines that don't dominate the picture; higher values give a more visible grid that's easier to read on busy footage. |
ResetGridOffsetCmd |
Command |
get |
Reset position and thickness to their defaults (centred, 1 px thick). |
Inherits from: AbstractOperator, AbstractAudioMetering.
See also: Alignment Grid in Operators — user-facing introduction, screenshots, and section summaries.