Skip to main content
Version: latest

agrag.common.data_models.navigation.NavigationRelation

Bases: StrEnum

The neighbor relation a navigation call follows.

Attributes:

  • PARENT – The section or sections that hold the passage.
  • CHILDREN – The other passages under the same parent node.
  • SIBLINGS – The other sections under the same parent section.
  • PREVIOUS – The passage before this one in reading order.
  • NEXT – The passage after this one in reading order.
  • TABLE_CONTEXT – The row passages before and after a table passage, with the table itself.

CHILDREN​

CHILDREN = 'children'

NEXT​

NEXT = 'next'

PARENT​

PARENT = 'parent'

PREVIOUS​

PREVIOUS = 'previous'

SIBLINGS​

SIBLINGS = 'siblings'

TABLE_CONTEXT​

TABLE_CONTEXT = 'table_context'