Class FigureCitationPopover

Figure Citation Popover Class Displays image previews in a popover when hovering over figure citations

Hierarchy

HoverPopover
- FigureCitationPopover

Index

Constructors

Properties

figuresToRender mouseX? mouseY? plugin sourcePath targetComponent targetEl

Methods

onClose onload onOpen onunload showFigures

Constructors

constructor

new FigureCitationPopover(
    plugin: default,
    parent: HoverParent,
    targetEl: HTMLElement,
    figuresToRender: RenderedFigure[],
    sourcePath: string,
    waitTime?: number,
    mouseX?: number,
    mouseY?: number,
): FigureCitationPopover
Parameters
- plugin: default
- parent: HoverParent
- targetEl: HTMLElement
- figuresToRender: RenderedFigure[]
- sourcePath: string
- OptionalwaitTime: number
- OptionalmouseX: number
- OptionalmouseY: number
Returns FigureCitationPopover
Overrides HoverPopover.constructor
- Defined in src/views/popovers/figure_citation_popover.tsx:39

Properties

`Private` `Readonly`figuresToRender

figuresToRender: RenderedFigure[] = []

`Private` `Optional` `Readonly`mouseX

mouseX?: number

`Private` `Optional` `Readonly`mouseY

mouseY?: number

`Private` `Readonly`plugin

plugin: default

`Private` `Readonly`sourcePath

sourcePath: string

`Private` `Readonly`targetComponent

targetComponent: TargetElComponent

`Private` `Readonly`targetEl

targetEl: HTMLElement

Methods

onClose

onClose(this: void): void
Parameters
- this: void
Returns void
- Defined in src/views/popovers/figure_citation_popover.tsx:66

onload

onload(): void
Override this to load your component

Returns void

Since
0.9.7
Overrides HoverPopover.onload
- Defined in src/views/popovers/figure_citation_popover.tsx:68

onOpen

onOpen(): void
Returns void
- Defined in src/views/popovers/figure_citation_popover.tsx:65

onunload

onunload(): void
Override this to unload your component

Returns void

Since
0.9.7
Overrides HoverPopover.onunload
- Defined in src/views/popovers/figure_citation_popover.tsx:73

showFigures

showFigures(): Promise<void>
Display figures in the popover.

The popover is rendered with visibility: hidden for the first frame so the user doesn't see content flicker while async assets (MathJax equations, figure markdown rendering) finish loading. Layout is performed while hidden, then adjustPopoverPosition measures the final popover size and we reveal it.

Returns Promise<void>
- Defined in src/views/popovers/figure_citation_popover.tsx:87