Equation Citator v1.3.7 Documentation
    Preparing search index...

    Interface EquationCitatorSettings

    To add a new setting:

    1. add into EquationCitatorSettings
    2. add default value in DEFAULT_SETTINGS
    3. add callback function in SettingsMetadata, and implement the callback function
    4. add settings into settingsHelper script (to give it a clear category)
    interface EquationCitatorSettings {
        addImageCaptionsInPdf: boolean;
        addImageDescInPdf: boolean;
        advancedSettingsKeys: string[];
        autoNumberDelimiter: string;
        autoNumberDepth: number;
        autoNumberGlobalPrefix: string;
        autoNumberNoHeadingPrefix: string;
        autoNumberType: AutoNumberingType;
        basicSettingsKeys: string[];
        cacheCleanTime: number;
        cacheUpdateTime: number;
        calloutCitationPrefixes: CalloutCitationPrefix[];
        citationColorInPdf: string;
        citationFormat: string;
        citationPopoverSize: string;
        citationPrefix: string;
        continuousDelimiters: string;
        continuousRangeSymbol: string;
        debugMode: boolean;
        deleteRepeatTagsInAutoNumber: boolean;
        deleteUnusedTagsInAutoNumber: boolean;
        enableAutoNumberEquationsInQuotes: boolean;
        enableAutoNumberFigsInQuotes: boolean;
        enableAutoNumberTaggedEquationsOnly: boolean;
        enableAutoNumberTaggedFigsOnly: boolean;
        enableCenterTableInCallout: boolean;
        enableCitationInSourceMode: boolean;
        enableCiteWithCodeBlockInCallout: boolean;
        enableContinuousCitation: boolean;
        enableCrossFileCitation: boolean;
        enableRenderFigureInfoInPreview: boolean;
        enableRenderLocalFileName: boolean;
        enableRichAutoComplete: boolean;
        enableRichAutoCompleteHoverPreview: boolean;
        enableTypstMode: boolean;
        enableUpdateTagsInAutoNumber: boolean;
        equationManagePanelDefaultViewType: "list" | "outline";
        equationManagePanelEnableRenderHeadingsOnly: boolean;
        equationManagePanelFileCheckInterval: number;
        equationManagePanelFilterBoxedEquation: boolean;
        equationManagePanelFilterTagOnlyEquation: boolean;
        equationManagePanelLazyUpdateTime: number;
        equationManagePanelPreviewObjectType: "equation" | "figure" | "callout";
        equationWidgetRightClickCopyType: "full" | "noTag" | "eq";
        extensionsUseMarkdownRenderer: string[];
        figAutoNumberDelimiter: string;
        figAutoNumberDepth: number;
        figAutoNumberGlobalPrefix: string;
        figAutoNumberNoHeadingPrefix: string;
        figCitationFormat: string;
        figCitationPrefix: string;
        fileCiteDelimiter: string;
        injectCitationMetadataInExportedMarkdown: boolean;
        keepImageSpacingForPdf: boolean;
        multiCitationDelimiter: string;
        multiCitationDelimiterRender: string;
        renderImageCaptionsAndDescriptions: boolean;
        richAutoCompletePreviewDelayTime: number;
        settingsDisplayMode: "list" | "categorical" | "concise";
        skipFirstlineInBoxedFilter: boolean;
        typstBoxSymbol: string;
        useFastMathRenderer: boolean;
        websiteNotesExcludedFolders: WebsiteNotesExcludedFolder[];
        websiteNotesExportFolder: string;
        websiteNotesExportIgnoredFilePatterns: string[];
    }
    Index

    Properties

    addImageCaptionsInPdf addImageDescInPdf advancedSettingsKeys autoNumberDelimiter autoNumberDepth autoNumberGlobalPrefix autoNumberNoHeadingPrefix autoNumberType basicSettingsKeys cacheCleanTime cacheUpdateTime calloutCitationPrefixes citationColorInPdf citationFormat citationPopoverSize citationPrefix continuousDelimiters continuousRangeSymbol debugMode deleteRepeatTagsInAutoNumber deleteUnusedTagsInAutoNumber enableAutoNumberEquationsInQuotes enableAutoNumberFigsInQuotes enableAutoNumberTaggedEquationsOnly enableAutoNumberTaggedFigsOnly enableCenterTableInCallout enableCitationInSourceMode enableCiteWithCodeBlockInCallout enableContinuousCitation enableCrossFileCitation enableRenderFigureInfoInPreview enableRenderLocalFileName enableRichAutoComplete enableRichAutoCompleteHoverPreview enableTypstMode enableUpdateTagsInAutoNumber equationManagePanelDefaultViewType equationManagePanelEnableRenderHeadingsOnly equationManagePanelFileCheckInterval equationManagePanelFilterBoxedEquation equationManagePanelFilterTagOnlyEquation equationManagePanelLazyUpdateTime equationManagePanelPreviewObjectType equationWidgetRightClickCopyType extensionsUseMarkdownRenderer figAutoNumberDelimiter figAutoNumberDepth figAutoNumberGlobalPrefix figAutoNumberNoHeadingPrefix figCitationFormat figCitationPrefix fileCiteDelimiter injectCitationMetadataInExportedMarkdown keepImageSpacingForPdf multiCitationDelimiter multiCitationDelimiterRender renderImageCaptionsAndDescriptions richAutoCompletePreviewDelayTime settingsDisplayMode skipFirstlineInBoxedFilter typstBoxSymbol useFastMathRenderer websiteNotesExcludedFolders websiteNotesExportFolder websiteNotesExportIgnoredFilePatterns

    Properties

    addImageCaptionsInPdf: boolean
    addImageDescInPdf: boolean
    advancedSettingsKeys: string[]
    autoNumberDelimiter: string
    autoNumberDepth: number
    autoNumberGlobalPrefix: string
    autoNumberNoHeadingPrefix: string
    autoNumberType: AutoNumberingType
    basicSettingsKeys: string[]
    cacheCleanTime: number
    cacheUpdateTime: number
    calloutCitationPrefixes: CalloutCitationPrefix[]
    citationColorInPdf: string
    citationFormat: string
    citationPopoverSize: string
    citationPrefix: string
    continuousDelimiters: string
    continuousRangeSymbol: string
    debugMode: boolean
    deleteRepeatTagsInAutoNumber: boolean
    deleteUnusedTagsInAutoNumber: boolean
    enableAutoNumberEquationsInQuotes: boolean
    enableAutoNumberFigsInQuotes: boolean
    enableAutoNumberTaggedEquationsOnly: boolean
    enableAutoNumberTaggedFigsOnly: boolean
    enableCenterTableInCallout: boolean
    enableCitationInSourceMode: boolean
    enableCiteWithCodeBlockInCallout: boolean
    enableContinuousCitation: boolean
    enableCrossFileCitation: boolean
    enableRenderFigureInfoInPreview: boolean
    enableRenderLocalFileName: boolean
    enableRichAutoComplete: boolean
    enableRichAutoCompleteHoverPreview: boolean
    enableTypstMode: boolean
    enableUpdateTagsInAutoNumber: boolean
    equationManagePanelDefaultViewType: "list" | "outline"
    equationManagePanelEnableRenderHeadingsOnly: boolean
    equationManagePanelFileCheckInterval: number
    equationManagePanelFilterBoxedEquation: boolean
    equationManagePanelFilterTagOnlyEquation: boolean
    equationManagePanelLazyUpdateTime: number
    equationManagePanelPreviewObjectType: "equation" | "figure" | "callout"
    equationWidgetRightClickCopyType: "full" | "noTag" | "eq"
    extensionsUseMarkdownRenderer: string[]
    figAutoNumberDelimiter: string
    figAutoNumberDepth: number
    figAutoNumberGlobalPrefix: string
    figAutoNumberNoHeadingPrefix: string
    figCitationFormat: string
    figCitationPrefix: string
    fileCiteDelimiter: string
    injectCitationMetadataInExportedMarkdown: boolean
    keepImageSpacingForPdf: boolean
    multiCitationDelimiter: string
    multiCitationDelimiterRender: string
    renderImageCaptionsAndDescriptions: boolean
    richAutoCompletePreviewDelayTime: number
    settingsDisplayMode: "list" | "categorical" | "concise"
    skipFirstlineInBoxedFilter: boolean
    typstBoxSymbol: string
    useFastMathRenderer: boolean
    websiteNotesExcludedFolders: WebsiteNotesExcludedFolder[]
    websiteNotesExportFolder: string
    websiteNotesExportIgnoredFilePatterns: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    addImageCaptionsInPdfaddImageDescInPdfadvancedSettingsKeysautoNumberDelimiterautoNumberDepthautoNumberGlobalPrefixautoNumberNoHeadingPrefixautoNumberTypebasicSettingsKeyscacheCleanTimecacheUpdateTimecalloutCitationPrefixescitationColorInPdfcitationFormatcitationPopoverSizecitationPrefixcontinuousDelimiterscontinuousRangeSymboldebugModedeleteRepeatTagsInAutoNumberdeleteUnusedTagsInAutoNumberenableAutoNumberEquationsInQuotesenableAutoNumberFigsInQuotesenableAutoNumberTaggedEquationsOnlyenableAutoNumberTaggedFigsOnlyenableCenterTableInCalloutenableCitationInSourceModeenableCiteWithCodeBlockInCalloutenableContinuousCitationenableCrossFileCitationenableRenderFigureInfoInPreviewenableRenderLocalFileNameenableRichAutoCompleteenableRichAutoCompleteHoverPreviewenableTypstModeenableUpdateTagsInAutoNumberequationManagePanelDefaultViewTypeequationManagePanelEnableRenderHeadingsOnlyequationManagePanelFileCheckIntervalequationManagePanelFilterBoxedEquationequationManagePanelFilterTagOnlyEquationequationManagePanelLazyUpdateTimeequationManagePanelPreviewObjectTypeequationWidgetRightClickCopyTypeextensionsUseMarkdownRendererfigAutoNumberDelimiterfigAutoNumberDepthfigAutoNumberGlobalPrefixfigAutoNumberNoHeadingPrefixfigCitationFormatfigCitationPrefixfileCiteDelimiterinjectCitationMetadataInExportedMarkdownkeepImageSpacingForPdfmultiCitationDelimitermultiCitationDelimiterRenderrenderImageCaptionsAndDescriptionsrichAutoCompletePreviewDelayTimesettingsDisplayModeskipFirstlineInBoxedFiltertypstBoxSymboluseFastMathRendererwebsiteNotesExcludedFolderswebsiteNotesExportFolderwebsiteNotesExportIgnoredFilePatterns