DomPositioningFunctionResult
interface
The result of PositioningFunction.
Properties
-
config : object | undefinedmodule:utils/dom/position~DomPositioningFunctionResult#configAn optional configuration that will pass-through the
getOptimalPositionhelper to theDomPointreturned by this helper. This configuration may, for instance, let the user ofgetOptimalPositionknow that this particular position comes with a certain presentation. -
left : numbermodule:utils/dom/position~DomPositioningFunctionResult#leftThe
leftvalue of the element rect that would represent the position. -
name : string | undefinedmodule:utils/dom/position~DomPositioningFunctionResult#nameThe name of the position. It helps the user of the
getOptimalPositionhelper to recognize different positioning function results. It will pass through to theDomPointreturned by the helper. -
top : numbermodule:utils/dom/position~DomPositioningFunctionResult#topThe
topvalue of the element rect that would represent the position.