@microsoft/fast-foundation > AnchoredRegionConfig

AnchoredRegionConfig interface

A utility interface to store anchored region configurations that correspond to various common flyout positioning schemes

Signature:

export interface AnchoredRegionConfig 

Properties

Property	Type	Description
autoUpdateMode	AutoUpdateMode	The auto-update setting of the component
fixedPlacement	boolean	Whether the region is positioned using css "position: fixed". Otherwise the region uses "position: absolute". Fixed placement allows the region to break out of parent containers,
horizontalDefaultPosition	HorizontalPosition	The default horizontal position of the region relative to the anchor element
horizontalInset	boolean	hether the region overlaps the anchor on the horizontal axis
horizontalPositioningMode	AxisPositioningMode	Sets what logic the component uses to determine horizontal placement.
horizontalScaling	AxisScalingMode	Defines how the width of the region is calculate
horizontalThreshold	number	How short the space allocated to the default position has to be before the widest area is selected for layout
horizontalViewportLock	boolean	Whether the region remains in the viewport (ie. detaches from the anchor) on the horizontal axis
verticalDefaultPosition	VerticalPosition	The default vertical position of the region relative to the anchor element
verticalInset	boolean	Whether the region overlaps the anchor on the vertical axis
verticalPositioningMode	AxisPositioningMode	Sets what logic the component uses to determine vertical placement.
verticalScaling	AxisScalingMode	Defines how the height of the region is calculated
verticalThreshold	number	How short the space allocated to the default position has to be before the tallest area is selected for layout
verticalViewportLock	boolean	Whether the region remains in the viewport (ie. detaches from the anchor) on the vertical axis