Septima.Search.DetailsHandlerDef

Decorates a result

Options

NameTypeMandatoryDefault valueDescription
proxyObjectIndites whether a proxy for the result should be used
proxy.itemObjectDescribes how to present the found proxy
proxy.item.labelObject
proxy.item.typeObjectresultresult
proxy.item.showObjecttrueshould the found proxy be shown
proxy.resultObjectYesDescribes how to find the proxyResult
proxy.result.searcherObjectYeswhich searcher to use
proxy.result.typeIdObjectYeswhich type of result
proxy.result.idObjectYes[mainresult.type->] id of proxy result. "$." is replaced with result.data property values (see examples)
morebooleantrueIndicates whether the details provided should be considered an extension of the result rather than related information (Layouts may show "more" handlers at the top without specific heading)
targetsboolean[{source: '', typeId: ''}Arrayof Combinations of source/typeIds that are supported by the handler
buttonTextstring""Title of the handler (Layouts may show the title as tab caption)
buttonImagestringicons.infoGreyUrl to icon of the handler (Layouts may show the image as part of the tab caption)
metastringDescription (e.g metadata of output) of the handler (A Detail Itens)
loggerObject
logLevelstring
idstringrandom unique string
isApplicableFunctionfunctioncheck against options.targetsfunction, (result)=>, return boolean indicating whether the result is handled
handlerfunctionYesfunction, (result)=>, return detail items
metafunctionYesdetailItem, som repræsenterer metadata

Examples

Usage

YAML Declaration:


   dawa:
    _type: Septima.Search.DawaSearcher
    _options:
      minimumShowCount: 3
      resultTypes:
        adresse:
          singular: Adresse
          plural: Adresser
          iconURI: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2ZXJzaW9uPSIxLjEiIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBkPSJNMTQsOUgxOS41TDE0LDMuNVY5TTcsMkgxNUwyMSw4VjIwQTIsMiAwIDAsMSAxOSwyMkg3QzUuODksMjIgNSwyMS4xIDUsMjBWNEEyLDIgMCAwLDEgNywyTTExLjkzLDEyLjQ0QzEyLjM0LDEzLjM0IDEyLjg2LDE0LjA4IDEzLjQ2LDE0LjU5TDEzLjg3LDE0LjkxQzEzLDE1LjA3IDExLjgsMTUuMzUgMTAuNTMsMTUuODRWMTUuODRMMTAuNDIsMTUuODhMMTAuOTIsMTQuODRDMTEuMzcsMTMuOTcgMTEuNywxMy4xOCAxMS45MywxMi40NE0xOC40MSwxNi4yNUMxOC41OSwxNi4wNyAxOC42OCwxNS44NCAxOC42OSwxNS41OUMxOC43MiwxNS4zOSAxOC42NywxNS4yIDE4LjU3LDE1LjA0QzE4LjI4LDE0LjU3IDE3LjUzLDE0LjM1IDE2LjI5LDE0LjM1TDE1LDE0LjQyTDE0LjEzLDEzLjg0QzEzLjUsMTMuMzIgMTIuOTMsMTIuNDEgMTIuNTMsMTEuMjhMMTIuNTcsMTEuMTRDMTIuOSw5LjgxIDEzLjIxLDguMiAxMi41NSw3LjU0QzEyLjM5LDcuMzggMTIuMTcsNy4zIDExLjk0LDcuM0gxMS43QzExLjMzLDcuMyAxMSw3LjY5IDEwLjkxLDguMDdDMTAuNTQsOS40IDEwLjc2LDEwLjEzIDExLjEzLDExLjM0VjExLjM1QzEwLjg4LDEyLjIzIDEwLjU2LDEzLjI1IDEwLjA1LDE0LjI4TDkuMDksMTYuMDhMOC4yLDE2LjU3QzcsMTcuMzIgNi40MywxOC4xNiA2LjMyLDE4LjY5QzYuMjgsMTguODggNi4zLDE5LjA1IDYuMzcsMTkuMjNMNi40LDE5LjI4TDYuODgsMTkuNTlMNy4zMiwxOS43QzguMTMsMTkuNyA5LjA1LDE4Ljc1IDEwLjI5LDE2LjYzTDEwLjQ3LDE2LjU2QzExLjUsMTYuMjMgMTIuNzgsMTYgMTQuNSwxNS44MUMxNS41MywxNi4zMiAxNi43NCwxNi41NSAxNy41LDE2LjU1QzE3Ljk0LDE2LjU1IDE4LjI0LDE2LjQ0IDE4LjQxLDE2LjI1TTE4LDE1LjU0TDE4LjA5LDE1LjY1QzE4LjA4LDE1Ljc1IDE4LjA1LDE1Ljc2IDE4LDE1Ljc4SDE3Ljk2TDE3Ljc3LDE1LjhDMTcuMzEsMTUuOCAxNi42LDE1LjYxIDE1Ljg3LDE1LjI5QzE1Ljk2LDE1LjE5IDE2LDE1LjE5IDE2LjEsMTUuMTlDMTcuNSwxNS4xOSAxNy45LDE1LjQ0IDE4LDE1LjU0TTguODMsMTdDOC4xOCwxOC4xOSA3LjU5LDE4Ljg1IDcuMTQsMTlDNy4xOSwxOC42MiA3LjY0LDE3Ljk2IDguMzUsMTcuMzFMOC44MywxN00xMS44NSwxMC4wOUMxMS42Miw5LjE5IDExLjYxLDguNDYgMTEuNzgsOC4wNEwxMS44NSw3LjkyTDEyLDcuOTdDMTIuMTcsOC4yMSAxMi4xOSw4LjUzIDEyLjA5LDkuMDdMMTIuMDYsOS4yM0wxMS45LDEwLjA1TDExLjg1LDEwLjA5WiIgLz48L3N2Zz4=
    detailhandlers:
      - _type: Septima.Search.InfoForSognProvider
        _options:
          more: false
          buttonText: Ligger i sogn
          proxy:
            item:
              type: result
              label: Ligger i sogn
              show: true
            result:
              searcher: 
                _ref: $.mysearchers.geosearcher
              typeId: sogne
              id: $.properties.sogn.kode

YAML Declaration: (SqDetailsHandler fires for results of type produktionsenhed)


  cvr:
    _type: Septima.Search.DataApi.CvrSearcher
    _options:
      fetcher:
        _type: Septima.Search.DataApi.Fetcher
    detailhandlers:
      - _type: Septima.Search.SqDetailsHandler
        _options:
          buttonText: Planer for ejende virksomhed
          proxy:
            item:
              type: result
              label: Ejende virksomhed
              show: true
            result:
              searcher:
                _ref: $.mysearchers.cvr
              typeId: virksomhed
              id: produktionsenhed->$.cvrnummer
        searchers:
          - _ref: "$.mysearchers.planSystemSearcher"