PopoverController
Class: PopoverController
Section titled “Class: PopoverController”Creates a scrollable popover in a map container.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PopoverController(options): PopoverController;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | PopoverOptions |
Returns
Section titled “Returns”PopoverController
Overrides
Section titled “Overrides”Methods
Section titled “Methods”adjustHeight()
Section titled “adjustHeight()”adjustHeight(): void;Adjusts height of the container to fit content.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”adjustScreenPosition()
Section titled “adjustScreenPosition()”adjustScreenPosition(): void;Adjsuts position of the popver.
Returns
Section titled “Returns”void
close()
Section titled “close()”close(): void;Closes the container
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy(): void;Destroys the controller.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getMainTemplate()
Section titled “getMainTemplate()”getMainTemplate(): string;This method must be overriden by a child class and to return an HTML code for the main content
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getToolbarTemplate()
Section titled “getToolbarTemplate()”getToolbarTemplate(): string;This method must be overriden by a child class and return an HTML code for the toolbar.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getWrapperTemplate()
Section titled “getWrapperTemplate()”getWrapperTemplate(): string;This method must be overriden by a child class and to return an HTML code for the main content
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”init()
Section titled “init()”init(): void;Initialization
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”is(name): boolean;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
name | string |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”moveSrceenPositionBy()
Section titled “moveSrceenPositionBy()”moveSrceenPositionBy(deltaX, deltaY): void;Moves popover by given numbers
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
deltaX | number | |
deltaY | number |
Returns
Section titled “Returns”void
open()
Section titled “open()”open(): void;Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”redraw()
Section titled “redraw()”redraw(): void;Redraws the container.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”render()
Section titled “render()”render(): void;Renders the content.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”resize()
Section titled “resize()”resize(): void;Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setEventHandlers()
Section titled “setEventHandlers()”setEventHandlers(): void;Sets event handlers
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setMainTemplate()
Section titled “setMainTemplate()”setMainTemplate(template): HandlebarsTemplateDelegate<any>;Sets the template for the body
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
template | any |
Returns
Section titled “Returns”HandlebarsTemplateDelegate<any>
Inherited from
Section titled “Inherited from”setOptions()
Section titled “setOptions()”setOptions(options): void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | Record<string, any> |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setPoint()
Section titled “setPoint()”setPoint(point): void;Sets a point where the popover should be shown
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
point | SVGPoint | [x,y] |
Returns
Section titled “Returns”void
setScreenPosition()
Section titled “setScreenPosition()”setScreenPosition(x, y): void;Set popover position by given numbers
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
x | number | |
y | number |
Returns
Section titled “Returns”void
setState()
Section titled “setState()”setState(state?, overwrite?): void;Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
state? | { [key: string]: any; } | undefined |
overwrite? | boolean | false |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setStyles()
Section titled “setStyles()”setStyles(styles): void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
styles | Partial<CSSStyleDeclaration> |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”updateScroll()
Section titled “updateScroll()”updateScroll(): void;Updates the size of the scrollable container. Automatically fires when window size or content size changes.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”updateTopShift()
Section titled “updateTopShift()”updateTopShift(): void;Updates top shift of the main container depending on toolbar height
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”viewDidAppear()
Section titled “viewDidAppear()”abstract viewDidAppear(): void;Fires when the view appears after being hidden. Should be overriden by a child class.
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”viewDidDisappear()
Section titled “viewDidDisappear()”abstract viewDidDisappear(): void;This method fires when the view disappears. Should be overriden by a child class.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”viewDidLoad()
Section titled “viewDidLoad()”viewDidLoad(): void;This method fires when the view is fully loaded. Can be used to do any final actions.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”viewDidRedraw()
Section titled “viewDidRedraw()”viewDidRedraw(): void;Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”viewWillRedraw()
Section titled “viewWillRedraw()”viewWillRedraw(): void;Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”_canClose
Section titled “_canClose”_canClose: boolean;Inherited from
Section titled “Inherited from”autoresize
Section titled “autoresize”autoresize: boolean;Inherited from
Section titled “Inherited from”classList
Section titled “classList”classList: string[];Inherited from
Section titled “Inherited from”closable
Section titled “closable”closable: boolean;Inherited from
Section titled “Inherited from”containers
Section titled “containers”containers: object;contentView?
Section titled “contentView?”optional contentView: HTMLElement;contentWrap?
Section titled “contentWrap?”optional contentWrap: HTMLElement;contentWrap2?
Section titled “contentWrap2?”optional contentWrap2: HTMLElement;optional main: HTMLElement;parent
Section titled “parent”parent: HTMLElement;sizer?
Section titled “sizer?”optional sizer: HTMLElement;toolbar?
Section titled “toolbar?”optional toolbar: HTMLElement;optional view: HTMLElement;Inherited from
Section titled “Inherited from”destroyed
Section titled “destroyed”destroyed: boolean;Inherited from
Section titled “Inherited from”eventOptions
Section titled “eventOptions”eventOptions: object & object;Type declaration
Section titled “Type declaration”afterClose?
Section titled “afterClose?”optional afterClose: BaseEventHandler<{ controller: BaseController;}>;afterLoad?
Section titled “afterLoad?”optional afterLoad: BaseEventHandler<{ controller: BaseController;}>;afterRedraw?
Section titled “afterRedraw?”optional afterRedraw: BaseEventHandler<{ controller: BaseController;}>;afterShow?
Section titled “afterShow?”optional afterShow: BaseEventHandler<{ controller: BaseController;}>;afterUnload?
Section titled “afterUnload?”optional afterUnload: BaseEventHandler<{ controller: BaseController;}>;beforeClose?
Section titled “beforeClose?”optional beforeClose: BaseEventHandler<{ controller: BaseController;}>;beforeLoad?
Section titled “beforeLoad?”optional beforeLoad: BaseEventHandler<{ controller: BaseController;}>;beforeRedraw?
Section titled “beforeRedraw?”optional beforeRedraw: BaseEventHandler<{ controller: BaseController;}>;beforeShow?
Section titled “beforeShow?”optional beforeShow: BaseEventHandler<{ controller: BaseController;}>;resize?
Section titled “resize?”optional resize: BaseEventHandler<{ controller: BaseController;}>;Inherited from
Section titled “Inherited from”events
Section titled “events”events: Events;Inherited from
Section titled “Inherited from”fullscreen
Section titled “fullscreen”fullscreen: object;lg: boolean;md: boolean;sm: boolean;Inherited from
Section titled “Inherited from”id: string;loaded
Section titled “loaded”loaded: boolean;Inherited from
Section titled “Inherited from”map: MapSVGMap;Inherited from
Section titled “Inherited from”mapObject
Section titled “mapObject”mapObject: | Marker | Region;middlewareOptions
Section titled “middlewareOptions”middlewareOptions: Middleware[];Inherited from
Section titled “Inherited from”middlewares
Section titled “middlewares”middlewares: MiddlewareList;Inherited from
Section titled “Inherited from”mobileCloseBtn
Section titled “mobileCloseBtn”mobileCloseBtn: HTMLElement;Inherited from
Section titled “Inherited from”name: string;Inherited from
Section titled “Inherited from”noPadding?
Section titled “noPadding?”optional noPadding: boolean;Inherited from
Section titled “Inherited from”opened
Section titled “opened”opened: boolean;Inherited from
Section titled “Inherited from”openedFullscreen
Section titled “openedFullscreen”openedFullscreen: boolean = false;Inherited from
Section titled “Inherited from”options
Section titled “options”options: unknown;Inherited from
Section titled “Inherited from”parent?
Section titled “parent?”optional parent: ObjectWithEvents;Inherited from
Section titled “Inherited from”point: SVGPoint;position?
Section titled “position?”optional position: "absolute" | "relative" | "fixed";Inherited from
Section titled “Inherited from”resizeSensor
Section titled “resizeSensor”resizeSensor: ResizeSensor;Inherited from
Section titled “Inherited from”screenPoint
Section titled “screenPoint”screenPoint: ScreenPoint;scrollable
Section titled “scrollable”scrollable: boolean;Inherited from
Section titled “Inherited from”state: object;Index Signature
Section titled “Index Signature”[key: string]: anyInherited from
Section titled “Inherited from”styles
Section titled “styles”styles: Partial<CSSStyleDeclaration>;Inherited from
Section titled “Inherited from”template
Section titled “template”template: string;Inherited from
Section titled “Inherited from”templates
Section titled “templates”templates: object;main: HandlebarsTemplateDelegate<any>;toolbar
Section titled “toolbar”toolbar: HandlebarsTemplateDelegate<any>;Inherited from
Section titled “Inherited from”uid: number;Inherited from
Section titled “Inherited from”withToolbar
Section titled “withToolbar”withToolbar: boolean;Inherited from
Section titled “Inherited from”yShift
Section titled “yShift”yShift: number;