mirror of
https://github.com/sophokles187/data-cards.git
synced 2026-07-22 05:45:15 +00:00
7.3 KiB
7.3 KiB
Settings Reference
This page provides a comprehensive reference for all available settings in DataCards.
Using Settings
Settings can be specified in two ways:
- Global Settings: Set default values for all DataCards blocks in the plugin settings
- Per-Block Settings: Override global settings for specific code blocks
Global Settings
To access global settings:
- Open Obsidian Settings
- Navigate to "DataCards" in the Community Plugins section
- Adjust settings as needed
Per-Block Settings
To customize settings for a specific code block, add them after your query:
TABLE file.link, author, rating FROM #books
SORT rating DESC
// Settings
preset: portrait
imageProperty: cover
Complete Settings Reference
| Setting | Description | Default | Available Options |
|---|---|---|---|
| Preset Settings | |||
preset |
Card layout preset | grid |
grid, portrait, square, compact, dense, kanban |
columns |
Number of columns (code block only) | Preset-specific | Number (typically 1-6) |
| Kanban Settings | |||
kanbanStatusOptions |
Available status values for dropdowns | ["todo", "in-progress", "review", "done"] |
Array of status strings |
kanbanColors |
Colors for status columns | {} |
Object mapping status to color names |
kanbanColumnWidth |
Width of kanban columns | 300px |
CSS value (e.g., 250px, 20rem) |
kanbanColumnSpacing |
Space between kanban columns | 16 |
Number (pixels) |
newTaskPath |
Folder path for new tasks | "" |
Folder path (e.g., "Projects/Tasks") |
newTaskTemplate |
Default properties for new tasks | {} |
Object with property defaults |
| Image Settings | |||
imageProperty |
Frontmatter property to use for images | cover |
Any property name |
imageHeight |
Height of images | Preset-specific | CSS value (e.g., 200px) |
imageFit |
How images should fit | Preset-specific | cover, contain |
| Content Settings | |||
properties |
Properties to display | all |
all or array of property names |
exclude |
Properties to exclude | [] |
Array of property names |
scrollableProperties |
Enable scrolling for properties | false |
true, false |
contentHeight |
Height of scrollable content | 200px |
CSS value (e.g., 250px) |
| Display Settings | |||
showLabels |
Show property labels | true |
true, false |
cardSpacing |
Space between cards (pixels) | 16 |
Number |
enableShadows |
Add shadows to cards | true |
true, false |
propertiesAlign |
Text alignment for properties | left |
left, center, right |
titleAlign |
Text alignment for title | left |
left, center, right |
fontSize |
Text size for all elements | default |
larger, large, default, small, smaller |
truncateText |
Truncate long text with ellipsis | false |
true, false |
| Layout Settings | |||
columns |
Number of columns (fixed layout) | Preset-specific | Any positive integer |
dynamicColumns |
Auto-adjust columns based on width | false |
true, false |
minCardWidth |
Minimum card width for dynamic layout | 250px |
CSS value (e.g., 300px) |
| Boolean Settings | |||
booleanDisplayMode |
How to display boolean values | both |
both, checkbox, text |
showBooleanLabels |
Show text labels for booleans | true |
true, false |
booleanTrueText |
Custom text for true values | true |
Any text |
booleanFalseText |
Custom text for false values | false |
Any text |
| Interaction Settings | |||
enableClickableCards |
Make entire card clickable | false |
true, false |
| Date Formatting | |||
defaultDateFormat |
Format for displaying dates | YYYY-MM-DD |
Date format string |
| Mobile Settings | |||
mobilePreset |
Preset for mobile devices | Same as desktop | grid, portrait, square, compact, dense |
mobileColumns |
Columns on mobile devices | 1 |
1, 2, 3 |
mobileScrollableProperties |
Enable scrolling on mobile | true |
true, false |
mobileContentHeight |
Scrollable content height on mobile | 150px |
CSS value (e.g., 180px) |
forceMobileMode |
Force mobile layout (testing) | false |
true, false |
| Performance Settings | |||
enableLazyLoading |
Load images only when visible | false |
true, false |
| Update Settings | |||
refreshButton |
Manual refresh button (always available) | Always enabled | Hover over cards to see |
| Advanced (Experimental) | |||
enableDynamicUpdates |
Auto-update when properties change (legacy) | false |
true, false |
dynamicUpdate |
Enable updates for specific card | Inherits global | true, false |
refreshDelay |
Delay before refreshing (ms) | 2500 |
Number (milliseconds) |
Examples
Basic Example
TABLE file.link, author, rating, genre FROM #books
SORT rating DESC
// Settings
preset: portrait
imageProperty: cover
Advanced Example
TABLE file.link, author, rating, genre, cover FROM #books
SORT rating DESC
// Settings
preset: grid
imageProperty: cover
columns: 8
fontSize: small
showLabels: true
propertiesAlign: center
titleAlign: center
enableShadows: true
mobilePreset: compact
mobileColumns: 1
Scrollable Properties Example
TABLE file.link, author, summary, notes, ratings, genres, cover FROM #books
SORT rating DESC
// Settings
preset: grid
imageProperty: cover
scrollableProperties: true
contentHeight: 250px
Dynamic Columns Example
TABLE file.link, author, rating, genre, cover FROM #books
SORT rating DESC
// Settings
preset: grid
imageProperty: cover
dynamicColumns: true
minCardWidth: 280px
Settings Hierarchy Example
TABLE file.link, author, rating, genre, cover FROM #books
SORT rating DESC
// Settings
preset: grid
imageProperty: cover
columns: 10
// This will use exactly 10 columns, even if Dynamic Columns is enabled globally
Text Truncation Example
TABLE file.link, author, description, tags FROM #articles
SORT file.mtime DESC
// Settings
preset: compact
truncateText: true
fontSize: small
Kanban Board Example
TABLE file.link as "Task", priority, assignee, status FROM #project-tasks
SORT status ASC
// Settings
preset: kanban
kanbanStatusOptions: ["backlog", "in-progress", "review", "done"]
kanbanColors: {"backlog": "gray", "in-progress": "blue", "review": "orange", "done": "green"}
newTaskPath: "Projects/Tasks"
newTaskTemplate: {"priority": "medium", "assignee": ""}
Settings Hierarchy
When the same setting is defined in multiple places, the plugin follows this priority order (highest to lowest):
- Per-block settings (in code block
// Settingssection) - Global plugin settings (in Obsidian Settings → DataCards)
- Preset defaults (built-in defaults for each preset)
- Mobile overrides (always take priority on mobile devices)
Column Layout Priority
For column layout specifically:
- Per-block
columns: X- Forces fixed columns, ignores dynamic columns - Per-block
dynamicColumns: true/false- Overrides global dynamic columns setting - Global
dynamicColumns: true/false- Default when no per-block override - Mobile
mobileColumns- Always used on mobile devices