@argdown/core
    Preparing search index...

    Class StatementSelectionPlugin

    Excludes all statements from the selection that are

    • not selected by
      • the includeStatements settings
      • an isInMap flag
      • the chosen [[StatementSelectionMode]],
    • or are not connected by any relation to another element in the selection (only if excludeDisconnected is true).

    This plugin should be run after the [[PreselectionPlugin]] and [[StatementSelectionPlugin]] and before the [[MapPlugin]]. The exclusion can be deactivated by using setting excludeDisconnected selection setting to false.

    A statement is considered to be connected if

    • it has any relation to another element in the selection
    • it is used as a pcs statement (premise or conclusion).

    Implements

    Index

    Constructors

    constructor

    Properties

    defaults name prepare run

    Methods

    getSettings

    Constructors

    Properties

    defaults: ISelectionSettings
    name: string = "StatementSelectionPlugin"

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods