@rcsb/rcsb-saguaro-app
    Preparing search index...

    Class RcsbFvCoreBuilder

    This class provides static methods to build PFVs. PFVs should be always created using methods in this class

    Index

    Constructors

    constructor

    Methods

    addSelectButton buildSelectButton clearAdditionalSelectButton createFv getPolymerEntityInstanceMapAndBuildFv getPolymerEntityInstanceMapAndCustomBuildFv showMessage unmount

    Constructors

    Methods

    • Parameters

      • elementFvId: string
      • selectButtonId: string

      Returns void

    • Parameters

      Returns Promise<RcsbFvModulePublicInterface<{}, {}, {}, {}>>

      This method implements a centralized point where PFVs are created. All PFV should be created using this method directly or through <CreateFvInterface.getPolymerEntityInstanceMapAndBuildFv>. In any case PFV should be built using a custom implementation.

    • Parameters

      • entryId: string

        PDB entry Id

      • createFvBuilder: (
            p: PolymerEntityInstanceTranslate,
        ) => Promise<RcsbFvModulePublicInterface<{}, {}, {}, {}>>

        This is the function used to create the PFV. Cases where buttons are needed will be created in custom definitions of createFvBuilder. The PFV should be always created calling RcsbFvCoreBuilder.createFv

      Returns Promise<RcsbFvModulePublicInterface<{}, {}, {}, {}>>

      The main purpose of this method is to have a unique point where Entity to Instance maps are collected. It forces to generate a that will be passed to the PFV create method

    • Parameters

      • elementId: string
      • message: string

      Returns void

    • Parameters

      • elementId: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods