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)

AppSidebar Component

Provides the application sidebar with editing controls, autodetection tools, and page navigation.


Overview

The AppSidebar component offers:

  • Sidebar controls for editing and navigation
  • Buttons for selection, drawing, adding, and deleting zones
  • Autodetection tools for measures/zones
  • Page navigation controls

Layout

  • Top: Mode buttons (select, draw, add zone, delete)
  • Middle: Autodetection tools (e.g., autodetect measures)
  • Bottom: Page navigation (current page, total pages, prev/next)

Props

None


Data

None


Computed Properties

NameDescription
isReadyWhether the app is ready for user actions
multiZoneWhether multi-zone mode is active
currentPageCurrent page number (1-based)
maxPageMaximum page number
prevAvailableWhether the previous page is available
nextAvailableWhether the next page is available
workingModeCurrent working mode (e.g., preprocessing, editing)
modeCurrent sidebar mode (selection, drawing, etc.)

Methods

NameDescription
showPrevPageNavigates to the previous page
showNextPageNavigates to the next page
autoDetectAutomatically detects zones on the current page
autoDetectAllAutomatically detects zones on all pages
activateModeActivates a specific mode (selection, drawing, etc.)

Example

<AppSidebar />
Prev
AppHeader Component
Next
ContentPreviewMdiv Component