Cartographer App User and Technical Documentation
Home
User Docs
Technical Docs
Home
User Docs
Technical Docs
  • User Documentation
    • Introduction
    • Getting Started
    • User Interface
    • Actions
  • Technical Documentation
    • GitHub Authentication
    • Components

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

Store Directory

This documentation contains information related to the store.

Overview

This Vuex store manages all application state, including:

  • Current MEI/XML document and page data
  • Undo/redo history of the MEI document (capped at 50 snapshots)
  • Modal visibility (for loading, editing, importing, etc.)
  • Current selection (page, measure, mdiv, zone)
  • GitHub integration (repositories and directories)
  • IIIF manifest ingestion, local image import, and image-reference verification
  • Annotation and zone management
  • Editor modes (from constants.js) and processing/loading states

Supporting Files

  • index.js — the Vuex store itself (state, mutations, actions, getters). See storeIndex.md for the detailed reference.
  • constants.js — exports the mode object enumerating the editor modes (selection, manualRect, splitVertical, splitHorizontal, additionalZone, deletion, mdiv, login).
  • client_id.js — exports the GitHub OAuth client id from process.env.VUE_APP_CLIENT_ID.
  • client_secret.js — exports the GitHub OAuth client secret from process.env.VUE_APP_CLIENT_SECRET.
  • call_back.js — exports the GitHub OAuth callback URL from process.env.VUE_APP_CALL_BACK.
Next
Tools