igniteui-angular
Version:
Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps
32 lines (31 loc) • 1.26 kB
TypeScript
import { PositionSettings, Size, Point } from './../utilities';
/**
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-position)
* Position strategies determine where to display the component in the provided IgxOverlayService.
*/
export interface IPositionStrategy {
/**
* PositionSettings to use when position the component in the overlay
*/
settings: PositionSettings;
/**
* Position the element based on the PositionStrategy implementing this interface.
*
* @param contentElement The HTML element to be positioned
* @param size Size of the element
* @param document reference to the Document object
* @param initialCall should be true if this is the initial call to the method
* @param target attaching target for the component to show
* ```typescript
* settings.positionStrategy.position(content, size, document, true);
* ```
*/
position(contentElement: HTMLElement, size?: Size, document?: Document, initialCall?: boolean, target?: Point | HTMLElement): void;
/**
* Clone the strategy instance.
* ```typescript
* settings.positionStrategy.clone();
* ```
*/
clone(): IPositionStrategy;
}