@argdown/core
    Preparing search index...

    Class PreselectionPlugin

    Creates the selection response field and populates it with statements and arguments filtered by:

    • selected tags
    • selected sections
    • isInMap flags
    • excluded statements
    • excluded arguments

    This plugin should be run before any other selection plugins and before the [[MapPlugin]].

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    defaults: ISelectionSettings
    name: string = "PreselectionPlugin"

    The name of the plugin

    prepare: IRequestHandler = ...

    Called each time the plugin's processor is run, before any other method of this plugin is called. Use this to add default settings to the request and to check that all required data is present in the response. If not, throw an [[ArgdownPluginError]] to cancel the the current processor's execution.

    run: IRequestHandler = ...

    Use this method to do the main work outside of the Argdown AST. This is the last method to be called by the [[ArgdownApplication]].

    Methods