docs › shapes › api reference › polygon reference

polygon reference

A filled shape defined by arbitrary vertices in unit coordinates.

structural properties

property type notes
Points Vector2[]? The vertices, in unit coordinates from 0 to 1 (origin top-left, x right, y down). Treated as immutable: do not mutate the array after assigning it.

layout

property type notes
FlexBasis Length? Initial main-axis size of a flex child before grow and shrink are applied.
FlexGrow float? Share of leftover main-axis space this child claims; 0 (default) means do not grow.
FlexShrink float? How readily this child shrinks when space is tight; 0 pins it to its basis.
Position PositionMode? Positioning scheme: Relative offsets from the normal slot, Absolute lifts the box out of flow against the nearest positioned ancestor.

position offsets

property type notes
Bottom Length? Bottom-edge offset; applied only when Position is Relative or Absolute.
Left Length? Left-edge offset; applied only when Position is Relative or Absolute.
Right Length? Right-edge offset; applied only when Position is Relative or Absolute.
Top Length? Top-edge offset; applied only when Position is Relative or Absolute.

sizing

property type notes
Width Length? Width of the box (Length: px, %, em, rem, ...).
Height Length? Height of the box.
MaxHeight Length? Upper bound on height.
MaxWidth Length? Upper bound on width; the box never grows past it.
MinHeight Length? Lower bound on height.
MinWidth Length? Lower bound on width; the box never shrinks below it.

spacing

property type notes
Margin Length? Outer space on all four edges, between this box and its neighbors.
MarginLeft Length? Outer space on the left edge.
MarginTop Length? Outer space on the top edge.
MarginRight Length? Outer space on the right edge.
MarginBottom Length? Outer space on the bottom edge.

background

property type notes
BackgroundColor Color? Fill color behind the content.
BackgroundTint Color? Multiplies the background image color; default white (no tint).

effects

property type notes
Opacity float? Overall opacity from 0 (transparent) to 1 (opaque).

transform

property type notes
Transform Goo.PanelTransform? Translate, rotate, scale, and skew applied to the rendered box.

misc

property type notes
PointerEvents PointerEvents? Whether the element receives pointer input (All or None).

events and key

property type notes
OnClick Action? Called when clicked with the left mouse button.
OnRightClick Action? Called when clicked with the right mouse button.
OnMiddleClick Action? Called when clicked with the middle mouse button.
OnMouseEnter Action? Called when the pointer enters.
OnMouseLeave Action? Called when the pointer leaves.
OnMouseDown Action? Called when a mouse button is pressed.
OnMouseUp Action? Called when a mouse button is released.
OnMouseMove Action? Called when the pointer moves over it.
Key string? Stable identity across rebuilds. Set it when this blob can change position among its siblings, so the reconciler matches it to the same panel.

see also