Overview
Label Navigation in Kodexa provides a powerful way to quickly find and jump to labeled regions in documents. Instead of scrolling through pages searching for specific data, you can filter, search, and navigate directly to labels using an interactive navigation panel.
What is Label Navigation?
Label Navigation is a document viewer feature that:
Lists all labels - Shows every labeled region in the document
Provides filtering - Search and filter labels by text, group, or page
Enables quick navigation - Click a label to jump directly to it in the document
Shows label details - Display label name, value, parent, and page number
Supports inverted view - Find labels that haven't been applied yet
Example use case: You're reviewing a 50-page contract. Instead of scrolling to find all "signature" labels, you filter the navigation panel to "signature" and see all 8 signatures listed with their page numbers. Click any signature to jump directly to it.
Accessing Label Navigation
In the Workspace
Open a document in the Workspace
The navigation panel appears on the left side
Lists all labeled regions in the document
Use filters and search to find specific labels
Navigation Panel Features
Filter Text Box
Search for labels by name or value:
Type in the filter box at the top
Filter applies to label names (case-insensitive)
Updates results in real-time as you type
Shows count of matching labels
Example: Type "invoice" to see all labels with "invoice" in their name
Group Filter
Filter labels by data group:
Multi-select dropdown below the filter box
Choose one or more data groups
Only shows labels from selected groups
Default: All top-level groups selected
Example: Select only "Line Items" group to see all line item labels
Show Labels With No Value
Toggle between two modes:
Normal mode (unchecked):
Shows labeled regions that exist in document
Each item displays the actual label instance
Click to navigate to that label in document
Shows label value and page number
Inverted mode (checked):
Shows available labels that haven't been applied
Useful for finding what's missing
Click + icon to add that label to selected text
Helps ensure completeness
Limit to Page
Restrict results to current page:
Checkbox to enable page filtering
When checked: Only shows labels on the page you're viewing
When unchecked: Shows labels from entire document
Useful for focused page-by-page review
Label List Display
Label Instance Cards
Each label in the list shows:
Color icon - Colored square with label icon (tag or page icon)
Label name - Name of the data element
Parent label - If label is in a group, shows parent
Value - Extracted or entered value for this label
Page number - Which page the label appears on
Click to Navigate
Clicking a label card:
Jumps to the page containing the label
Scrolls to the label's position
Highlights the labeled region
Opens Label Properties panel for that label
Using Normal Mode
Finding Labels
Ensure "Show labels with no value" is unchecked
Type in filter box to search by name
Select groups to filter by category
Optional: Check "Limit to page" for current page only
List shows matching label instances
Navigating to Labels
Scroll through the filtered list
Find the label you want to view
Click the label card
Document jumps to that label's location
Label is highlighted in the document
Result Count
Below the checkboxes:
Shows "{number} found"
Updates as you adjust filters
Helps gauge how many labels match
Using Inverted Mode
Finding Missing Labels
Check "Show labels with no value"
List shows labels defined but not yet applied
Organized by selected groups
Shows which data elements have no instances
Adding Missing Labels
Select text in the document (required)
Find the label you want to add in the list
Click the + icon on the label card
Label is applied to selected text
Label now appears in normal mode
Result Count
Shows "{number} available":
Count of labels not yet applied
Within selected groups
Matching filter text
Common Workflows
Quality Assurance Review
Scenario: Verify all required fields are labeled
Steps:
Check "Show labels with no value"
Review list of missing labels
For each missing required label:
Find appropriate text in document
Select the text
Click + on the missing label
When list is empty, all labels are applied
Verification Workflow
Scenario: Check all invoice line items
Steps:
Select "Line Items" group in filter
Review count to confirm expected number
Click each line item label
Verify value and properties
Make corrections as needed
Focused Page Review
Scenario: Review one page at a time
Steps:
Check "Limit to page"
Navigate to first page
Review all labels on that page
Move to next page
List updates to show next page's labels
Finding Specific Labels
Scenario: Locate all signature labels
Steps:
Type "signature" in filter box
List shows only matching labels
Click each to verify signatures present
Clear filter when done
Performance Optimization
Virtual Scrolling
The navigation panel uses virtual scrolling:
Only renders visible label cards
Handles documents with thousands of labels
Smooth scrolling performance
Approximately 88px per row
Label Caching
Label names are cached for performance:
Avoids repeated string operations
Faster filtering as you type
Optimized for real-time search
Pre-sorting
Labels are sorted by page number once:
Not re-sorted on every keystroke
Consistent ordering by page
Better performance with large documents
Best Practices
Use group filter - Narrow results to relevant categories
Combine filters - Use text search + group filter + page limit together
Check inverted mode - Periodically verify no required labels are missing
Page-by-page review - Enable "Limit to page" for thorough reviews
Clear filters - Reset between different searches
Watch the count - Use result count to gauge completeness
Navigate efficiently - Use navigation instead of scrolling for long documents
Advanced Features
Parent Label Display
When labels are in groups:
Shows parent group name
Helps understand label context
Example: "Line Items" parent for "item_description"
Page vs Tag Icons
Different icons indicate label type:
Tag icon - Standard label on specific text
Page icon - Page-level label
Both use label's configured color
Group Path Filtering
Group filtering uses path matching:
Selecting a group includes all child labels
Hierarchical filtering
Nested groups work correctly
Empty States
No Results Found
When filter returns no matches:
Shows "No labels found" message
Suggests trying different terms
Clear filter or adjust search
Help State
Type "?" in filter box:
Shows help information
Explains how to use navigation
Quick reference for features
Troubleshooting
Labels Not Appearing
Check group filter - may have wrong groups selected
Clear text filter - may be filtering out labels
Uncheck "Limit to page" - may be on wrong page
Verify document has labels applied
Can't Navigate to Label
Ensure clicking on the label card itself
Check document is loaded properly
Verify label exists on the page it claims
Refresh workspace if navigation fails
Inverted Mode Shows Nothing
All defined labels may already be applied
Check group filter - may exclude all unused labels
This is normal if document is complete
Count Seems Wrong
Verify all filters are as expected
Check if "Limit to page" is enabled
Group filter may exclude some labels
Text filter is case-insensitive but exact substring match
Keyboard Navigation
While not explicitly in the UI:
Tab through label cards
Enter to select focused label
Use filter box with keyboard
Accessibility-friendly navigation
Tips
Filter text box searches label names (not values)
Group filter uses multi-select - can choose multiple groups
"Show labels with no value" inverts the list completely
"Limit to page" is useful for page-by-page review workflow
Click + icon in inverted mode to add labels to selected text
Result count updates in real-time as you adjust filters
Parent label shows context for nested/grouped labels
Page number starts at 1 (internal is 0-indexed, display adds 1)
Virtual scrolling handles documents with thousands of labels
Labels sorted by page number for consistent ordering