Class EquationServices

Common class processing logic for equation files.

Services class need plugin instance to access settings and cache data, and provide common functions for equation files.

Index

Constructors

Properties

Methods

addTagToEquation addTagToEquationWithResult fillEquationsContent getEquationsByTags getEquationsForAutocomplete getMarkdownViewByPath linesStillContainEquation resolveCrossFileRef

Constructors

constructor

new EquationServices(plugin: default): EquationServices
Parameters
- plugin: default
Returns EquationServices
- Defined in src/services/equation_services.tsx:29

Properties

`Private` `Readonly`plugin

plugin: default

Methods

addTagToEquation

addTagToEquation(
    filePath: string,
    lineStart: number,
    lineEnd: number,
    tag: string,
): boolean
Parameters
- filePath: string
- lineStart: number
- lineEnd: number
- tag: string
Returns boolean
- Defined in src/services/equation_services.tsx:144

addTagToEquationWithResult

addTagToEquationWithResult(
    filePath: string,
    lineStart: number,
    lineEnd: number,
    tag: string,
    expectedContent?: string,
): AddEquationTagResult
Adds a tag to the equation at the cached line range after confirming the current editor still contains the same equation text. Returns a failure reason instead of silently returning false so callers can warn about stale panel data when refresh has been stopped.
Parameters
- filePath: string
- lineStart: number
- lineEnd: number
- tag: string
- OptionalexpectedContent: string
Returns AddEquationTagResult
- Defined in src/services/equation_services.tsx:154

`Private`fillEquationsContent

fillEquationsContent(equations: RenderedEquation[]): Promise<RenderedEquation[]>
Parameters
- equations: RenderedEquation[]
Returns Promise<RenderedEquation[]>
- Defined in src/services/equation_services.tsx:84

getEquationsByTags

getEquationsByTags(
eqNumbersAll: string[],
sourcePath: string,
): Promise<RenderedEquation[]>
Retrieves equations by their tags from a specified source file. Used in rename tags

This method processes both local and cross-file equation references based on plugin settings. For cross-file references, it resolves the actual file path using footnotes. It filters out invalid equations and fills in the equation content for valid ones.
Parameters
- eqNumbersAll: string[]
  An array of equation tags to retrieve
- sourcePath: string
  The path of the source file where the equations are referenced
Returns Promise<RenderedEquation[]>
A promise that resolves to an array of RenderedEquation objects containing equation details
Remarks
- Uses footnote information to resolve cross-file references when enabled in settings
- Filters out equations with invalid source paths
- Populates equation content by matching tags with cached equation data
- Returns an empty array if no valid equations are found
- Defined in src/services/equation_services.tsx:51

getEquationsForAutocomplete

getEquationsForAutocomplete(
tag: string,
sourcePath: string,
): Promise<RenderedEquation[]>
Parameters
- tag: string
- sourcePath: string
Returns Promise<RenderedEquation[]>
- Defined in src/services/equation_services.tsx:106

`Private`getMarkdownViewByPath

getMarkdownViewByPath(filePath: string): MarkdownView | null
Gets the MarkdownView for a file by its path
Parameters
- filePath: string
  The path of the file
Returns MarkdownView | null
The MarkdownView if found, null otherwise
- Defined in src/services/equation_services.tsx:252

`Private`linesStillContainEquation

linesStillContainEquation(
equationLines: string[],
expectedContent: string,
): boolean
Parameters
- equationLines: string[]
- expectedContent: string
Returns boolean
- Defined in src/services/equation_services.tsx:240

`Private`resolveCrossFileRef

resolveCrossFileRef(
    sourcePath: string,
    crossFile: string,
    footnotes: FootNote[] | undefined,
):
    | { filename: null; path: null }
    | { filename: string | null; path: string }
Parameters
- sourcePath: string
- crossFile: string
- footnotes: FootNote[] | undefined
Returns { filename: null; path: null } | { filename: string | null; path: string }
- Defined in src/services/equation_services.tsx:132