OrbiterEdgeOffsetType

@Deprecated(
    message = "Use OrbiterPosition.EdgeAlignment instead.",
    replaceWith = ReplaceWith("OrbiterPosition.EdgeAlignment"),
)
public class OrbiterEdgeOffsetType private constructor(private val value: Int)

Specifies how the Orbiter is offset relative to its parent's layout boundary.

Note: Calculates offset based on the parent's rectangular layout bounds, not its visual shape or rounded corners. Use a custom offset in DpVolumeOffset to align with curved or non-rectangular contours.

Members

Companion

public companion object

Properties

OuterEdge

@Deprecated(
            message = "Use OrbiterPosition.EdgeAlignment.Outside instead.",
            replaceWith = ReplaceWith("OrbiterPosition.EdgeAlignment.Outside"),
        )
        public val OuterEdge: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType(0)

Positions the Orbiter fully outside the parent's layout boundary.

The orbiter does not overlap the parent panel's layout bounds. For example, a side rail will sit completely to the side of the parent.

InnerEdge

@Deprecated(
            message = "Use OrbiterPosition.EdgeAlignment.Inside instead.",
            replaceWith = ReplaceWith("OrbiterPosition.EdgeAlignment.Inside"),
        )
        public val InnerEdge: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType(1)

Positions the Orbiter fully inside the parent's layout boundary.

The orbiter completely overlaps the parent panel's layout bounds, functioning as an overlay.

None

@Deprecated(
            message = "Use OrbiterPosition.EdgeAlignment.Center instead.",
            replaceWith = ReplaceWith("OrbiterPosition.EdgeAlignment.Center"),
        )
        public val None: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType(2)

Centers the Orbiter directly on the parent's layout boundary line.

The boundary line bisects the orbiter, placing it half-inside and half-outside the parent.