Class FigureServices

Service class for handling figure-related operations Similar to EquationServices but for images/figures

Index

Constructors

Properties

Methods

fillFiguresContent getFiguresByTags getFiguresForAutocomplete resolveCrossFileRef

Constructors

constructor

new FigureServices(plugin: default): FigureServices
Parameters
- plugin: default
Returns FigureServices
- Defined in src/services/figure_services.tsx:24

Properties

`Private` `Readonly`plugin

plugin: default

Methods

`Private`fillFiguresContent

fillFiguresContent(figures: RenderedFigure[]): Promise<RenderedFigure[]>
Fill figure content by querying the imageCache This function map the ImageMatch object to RenderedFigure.
Parameters
- figures: RenderedFigure[]
Returns Promise<RenderedFigure[]>
- Defined in src/services/figure_services.tsx:78

getFiguresByTags

getFiguresByTags(
figureTagsAll: string[],
sourcePath: string,
): Promise<RenderedFigure[]>
Retrieves figures by their tags from a specified source file Handles both local and cross-file figure references.
Parameters
- figureTagsAll: string[]
  An array of figure tags to retrieve
- sourcePath: string
  The path of the source file where the figures are referenced
Returns Promise<RenderedFigure[]>
A promise that resolves to an array of RenderedFigure objects
Remarks
1. The input is the figureTagsAll (which is 1^1.1, 1^3.2, 1^4.1) this function retrieve the corresponding figure information for each tag
2. This operation query both footnoteCache and imageCache, so it should be optimized and only called when necessary
- Defined in src/services/figure_services.tsx:39

getFiguresForAutocomplete

getFiguresForAutocomplete(
tag: string,
sourcePath: string,
): Promise<RenderedFigure[]>
Get figures for autocomplete suggestions
Parameters
- tag: string
- sourcePath: string
Returns Promise<RenderedFigure[]>
- Defined in src/services/figure_services.tsx:109

`Private`resolveCrossFileRef

resolveCrossFileRef(
    sourcePath: string,
    crossFile: string,
    footnotes: FootNote[] | undefined,
):
    | { filename: null; path: null }
    | { filename: string | null; path: string }
Resolve cross-file reference using footnotes
Parameters
- sourcePath: string
- crossFile: string
- footnotes: FootNote[] | undefined
Returns { filename: null; path: null } | { filename: string | null; path: string }
- Defined in src/services/figure_services.tsx:141