DatacoreSettings

cartographer

---

cartographer / DatacoreSettings

Interface: DatacoreSettings

Defined in: types/settings.ts:126

Configuration types for Cartographer plugin. Defines the complete settings structure, schemas, and library management.

This is the root settings object stored in Obsidian plugin storage. It includes all library configurations, active library selection, and UI preferences.

Example

const settings: DatacoreSettings = {
  libraries: [
    { id: "pulp-fiction", name: "Pulp Fiction", path: "pulp-fiction/works", schema: {...}, createdAt: "2026-01-01T00:00:00Z" }
  ],
  activeLibraryId: "pulp-fiction",
  schema: {...}, // Schema of the active library
  dashboards: {...},
  ui: { itemsPerPage: 20, defaultSortColumn: "title", defaultSortDesc: false, compactMode: false }
};

Properties

libraries

libraries: Library[]

Defined in: types/settings.ts:128

Array of configured libraries

---

activeLibraryId

activeLibraryId: string | null

Defined in: types/settings.ts:130

ID of currently active library, or null if none selected

---

schema

schema: CatalogSchema

Defined in: types/settings.ts:132

Schema of the active library (copy of schema from active Library object)

---

dashboards

dashboards: DashboardConfigs

Defined in: types/settings.ts:134

Dashboard and component visibility & configuration

---

ui

ui: object

Defined in: types/settings.ts:136

UI preferences and display options

itemsPerPage

itemsPerPage: number

Number of items to display per page in tables/lists

defaultSortColumn

defaultSortColumn: string

Default field to sort by (usually ‘title’)

defaultSortDesc

defaultSortDesc: boolean

Whether to sort descending by default

compactMode

compactMode: boolean

Whether to use compact mode in UI (condensed display)