Class CalloutServices

Service class for handling callout-related operations Similar to FigureServices but for callouts/quotes

Index

Constructors

Properties

Methods

fillCalloutsContent getCalloutsByTags getCalloutsForAutocomplete resolveCrossFileRef

Constructors

constructor

new CalloutServices(plugin: default): CalloutServices
Parameters
- plugin: default
Returns CalloutServices
- Defined in src/services/callout_services.tsx:26

Properties

`Private` `Readonly`plugin

plugin: default

Methods

`Private`fillCalloutsContent

fillCalloutsContent(
callouts: RenderedCallout[],
prefix: string,
): Promise<RenderedCallout[]>
Fill callout content by querying the calloutCache Only fetches callouts that match the specified prefix
Parameters
- callouts: RenderedCallout[]
- prefix: string
Returns Promise<RenderedCallout[]>
- Defined in src/services/callout_services.tsx:97

getCalloutsByTags

getCalloutsByTags(
    calloutTagsAll: string[],
    prefix: string,
    sourcePath: string,
): Promise<RenderedCallout[]>
Retrieves callouts by their tags from a specified source file Handles both local and cross-file callout references IMPORTANT: All tags must be of the same type/prefix
Parameters
- calloutTagsAll: string[]
  An array of callout tags to retrieve (e.g., ["1.1", "1.2"])
- prefix: string
  The prefix that identifies the callout type (e.g., "table:", "thm:")
- sourcePath: string
  The path of the source file where the callouts are referenced
Returns Promise<RenderedCallout[]>
A promise that resolves to an array of RenderedCallout objects
- Defined in src/services/callout_services.tsx:40

getCalloutsForAutocomplete

getCalloutsForAutocomplete(
    tag: string,
    prefix: string,
    sourcePath: string,
): Promise<RenderedCallout[]>
Get callouts for autocomplete suggestions Searches for callouts matching the given tag prefix and callout prefix
Parameters
- tag: string
  The partial tag to search for (e.g., "1.1")
- prefix: string
  The callout prefix (e.g., "table:", "thm:")
- sourcePath: string
  The source file path
Returns Promise<RenderedCallout[]>
Array of matching callouts
- Defined in src/services/callout_services.tsx:141

`Private`resolveCrossFileRef

resolveCrossFileRef(
    sourcePath: string,
    crossFileIndex: string,
    footnotes: FootNote[],
): { filename: string | null; path: string | null }
Resolve cross-file reference using footnote cache Returns the file path and filename for the reference
Parameters
- sourcePath: string
- crossFileIndex: string
- footnotes: FootNote[]
Returns { filename: string | null; path: string | null }
- Defined in src/services/callout_services.tsx:187