To which component border(s) we will stick menu (optional)
Position
Position.TOP_LEFT
extraOffset
Additional offset to stickTo (optional)
Object
{ left: 0, top: 0 }
computeOffset
Additional computed offset to stickTo (optional)
Function
{ left: 0, top: 0 }
stickTo parameter set relative base position of menu, it is always relative to component.
Position enum values
value
description
TOP_LEFT
Show the menu at the top left of the component
TOP_RIGHT
Show the menu at the top rigth of the component
TOP_CENTER
Show the menu at the top center of the component
BOTTOM_LEFT
Show the menu at the bottom left of the component
BOTTOM_RIGHT
Show the menu at the bottom right of the component
BOTTOM_CENTER
Show the menu at the bottom center of the component
extraOffset parameter set additional offset to base position of menu. It's used if you want customize stickTo, adding additional offset. extraOffset is an Object with the following allowed properties.
extraOffset can have duplicate properties (they all will be applied correctly)
{ top: 10, top: -5, top: 15 }
extraOffset values can be negative too
{ top: 10, top: -5, top: 15 }
computeOffset parameter is a callback function which will be called with position and size of component (computeOffset(left, top, width, height)). It's used if you want to customize stickTo dynamically and your computed offset depends on component position / size (for example to show menu centered you need to know component width).
computeOffset callback parameters
name
description
type
left
position of component on the horizontal axis (from top left window corner)
Number
top
position of component on the vertical axis (from top left window corner)
Number
width
width of component
Number
height
height of component
Number
computeOffset callback should return Object with the same properties as extraOffsetObject.
/* Example of computeOffset return value */
{
top: 10,
left: 15,
bottom: -3,
right: 15,
top: 12
}
Notes
You can use extraOffset parameter or computeOffset or both parameters simultaneously. So, the final position of menu is calculated as basePosition + extraOffset + computeOffset(left, top, width, height)
