Cartographer User and Technical Documentation
Home
User Docs
Technical Docs
Home
User Docs
Technical Docs
  • User Documentation
    • Introduction
    • Cartographer App
    • User Interface
    • Actions
  • Technical Documentation
    • Components

      • AppFooter Component
      • AppHeader Component
      • AppSidebar Component
      • ContentPreviewMdiv Component
      • Content Preview Measure
      • Content Preview Pane
      • ImageSelection Modal
      • LoadGitModal Component
      • LoadIIIFModal Component
      • LoadXMLModal Component
      • MainMenu Component
      • MeasureModal Component
      • MdivModal Component
      • OsdComponent Component
      • PageImportModal Component
      • PagesListEntry Component
      • PagesModal Component
    • Store
      • Vuex Store (src/store/index.js)
    • Tools
      • IIIF Tools (src/tools/iiif.js)
      • MEI Mapping Tools (src/tools/meimapping.js)

MainMenu Component

Displays a dropdown menu with actions for file import/export and toggling app features.


Overview

The MainMenu component provides:

  • A dropdown menu for importing MEI files and IIIF manifests
  • Downloading the current MEI file
  • Showing the page overview modal
  • Toggling the measure list pane
  • Toggling merge mode for existing music (if available)
  • Uses Vuex store for state management and dispatching actions

Layout

  • Dropdown Menu: Triggered by a button with a bars icon
  • Sections:
    • Data: Upload MEI, Import IIIF Manifest, Download MEI File
    • Actions: Show Page Overview, Toggle Measure List
    • Options: Toggle Merge Mode (if available)

Props

None


Computed Properties

NameDescription
accessTokenGitHub access token from the store
directoriesGitHub directories from the store
selectedDirectorySelected directory from the store
manifestCurrent manifest from the store
xmlFilenameFilename for MEI file download
downloadAvailableTrue if MEI file is available for download
isLoggedinTrue if the user is logged in
firstMeasureWithoutZoneFirst measure without a zone (for merge mode)
existingMusicModeWhether merge mode is active
getUserNameCurrent user's name from the store

Methods

NameDescription
importXMLOpens the modal to upload an MEI file
importManifestOpens the modal to import a IIIF manifest
xmlDataUrlReturns the data URL for downloading the MEI file
toggleMeasureListToggles the measure list pane
showPagesModalOpens the page overview modal
toggleExistingMusicModeToggles merge mode for existing music (if available)

Example

<MainMenu />
Prev
LoadXMLModal Component
Next
MeasureModal Component