Skip to main content
Version: 4.3

SelectionWrapperOptions

Options for the Selection wrapper prop — the overlay rectangle that hosts the selection handles and bbox outline, plus its handle / group config (handles render inside the wrapper; a hidden wrapper has no handles).

Extends

  • Omit<ui.HTMLSelectionWrapper.Options, "visibility">

Indexable

[key: string]: any
[key: number]: any

Properties

groups?

optional groups?: object;

Handle groups: see ui.Selection.HandleGroup.

Index Signature

[groupName: string]: HandleGroup

handles?

optional handles?: SelectionHandles;

Selection handles. Array to fully override the defaults, or a function (defaultHandles) => Selection.Handle[] to transform the defaults, useful for filtering / tweaking individual handles without re-listing them all. Mirrors the <Halo handles> pattern.


preserveAspectRatio?

optional preserveAspectRatio?: boolean;

Lock aspect ratio while resizing. Lives here because it only has meaning when the wrapper renders a resize handle.


rotateAngleGrid?

optional rotateAngleGrid?: number;

Rotation snap step (degrees). Lives here because it only has meaning when the wrapper renders a rotate handle.

Default

15

visibility?

optional visibility?: SelectionWrapperVisibility;

Whether the wrapper rectangle (and therefore its handles) is shown: true / false for a fixed value, or (collection) => boolean to decide dynamically from the current selection.

Default

shown only while more than one cell is selected