Skip to content

Class: NarrativeEntryProperties

Properties for a NarrativeEntry annotation

URI: debrief:class/NarrativeEntryProperties

 classDiagram
    class NarrativeEntryProperties
    click NarrativeEntryProperties href "../../classes/NarrativeEntryProperties/"
      BaseFeatureProperties <|-- NarrativeEntryProperties
        click BaseFeatureProperties href "../../classes/BaseFeatureProperties/"

      NarrativeEntryProperties : kind





        NarrativeEntryProperties --> "1" FeatureKindEnum : kind
        click FeatureKindEnum href "../../enums/FeatureKindEnum/"



      NarrativeEntryProperties : provenance





        NarrativeEntryProperties --> "*" LogEntry : provenance
        click LogEntry href "../../classes/LogEntry/"



      NarrativeEntryProperties : style





        NarrativeEntryProperties --> "1" PointProperties : style
        click PointProperties href "../../classes/PointProperties/"



      NarrativeEntryProperties : symbol

      NarrativeEntryProperties : tags

      NarrativeEntryProperties : text

      NarrativeEntryProperties : time

      NarrativeEntryProperties : track_id

      NarrativeEntryProperties : vertex_metadata





        NarrativeEntryProperties --> "*" VertexMetadata : vertex_metadata
        click VertexMetadata href "../../classes/VertexMetadata/"



      NarrativeEntryProperties : visible


Inheritance

Slots

Name Cardinality and Range Description Inheritance
kind 1
FeatureKindEnum
Feature type discriminator direct
time 1
datetime
Narrative timestamp (ISO8601) direct
text 1
String
Narrative text content direct
track_id 0..1
String
Associated track identifier (optional) direct
symbol 0..1
String
Display symbol code from REP file direct
style 1
PointProperties
Point styling properties for display position direct
tags *
String
Free-text labels assigned to this feature by the analyst BaseFeatureProperties
visible 0..1
Boolean
Whether this feature is shown on the map BaseFeatureProperties
provenance *
LogEntry
PROV-aligned provenance records (append-only log of tool operations) BaseFeatureProperties
vertex_metadata *
VertexMetadata
Sparse list of per-vertex metadata, keyed by path BaseFeatureProperties

Usages

used by used in type used
NarrativeEntry properties range NarrativeEntryProperties

Identifier and Mapping Information

Schema Source

  • from schema: https://debrief.info/schemas/debrief

Mappings

Mapping Type Mapped Value
self debrief:NarrativeEntryProperties
native debrief:NarrativeEntryProperties

LinkML Source

Direct

name: NarrativeEntryProperties
description: Properties for a NarrativeEntry annotation
from_schema: https://debrief.info/schemas/debrief
is_a: BaseFeatureProperties
attributes:
  kind:
    name: kind
    description: Feature type discriminator
    from_schema: https://debrief.info/schemas/annotations
    domain_of:
    - BaseFeatureProperties
    - TrackProperties
    - ReferenceLocationProperties
    - SystemStateProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - SelectionRequirement
    - SystemRecordProperties
    - StoryboardProperties
    - SceneProperties
    - MCPSelectionRequirement
    range: FeatureKindEnum
    required: true
    equals_string: NARRATIVE
  time:
    name: time
    description: Narrative timestamp (ISO8601)
    from_schema: https://debrief.info/schemas/annotations
    domain_of:
    - TimestampedPosition
    - MeasuredArrayPosition
    - SensorContact
    - TUASolution
    - NarrativeEntryProperties
    range: datetime
    required: true
  text:
    name: text
    description: Narrative text content
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    domain_of:
    - NarrativeEntryProperties
    - TextAnnotationProperties
    - MCPContentItem
    required: true
  track_id:
    name: track_id
    description: Associated track identifier (optional)
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    domain_of:
    - NarrativeEntryProperties
  symbol:
    name: symbol
    description: Display symbol code from REP file
    from_schema: https://debrief.info/schemas/annotations
    domain_of:
    - PositionStyle
    - PositionStyleOverride
    - ReferenceLocationProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
  style:
    name: style
    description: Point styling properties for display position
    from_schema: https://debrief.info/schemas/annotations
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    range: PointProperties
    required: true

Induced

name: NarrativeEntryProperties
description: Properties for a NarrativeEntry annotation
from_schema: https://debrief.info/schemas/debrief
is_a: BaseFeatureProperties
attributes:
  kind:
    name: kind
    description: Feature type discriminator
    from_schema: https://debrief.info/schemas/annotations
    alias: kind
    owner: NarrativeEntryProperties
    domain_of:
    - BaseFeatureProperties
    - TrackProperties
    - ReferenceLocationProperties
    - SystemStateProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - SelectionRequirement
    - SystemRecordProperties
    - StoryboardProperties
    - SceneProperties
    - MCPSelectionRequirement
    range: FeatureKindEnum
    required: true
    equals_string: NARRATIVE
  time:
    name: time
    description: Narrative timestamp (ISO8601)
    from_schema: https://debrief.info/schemas/annotations
    alias: time
    owner: NarrativeEntryProperties
    domain_of:
    - TimestampedPosition
    - MeasuredArrayPosition
    - SensorContact
    - TUASolution
    - NarrativeEntryProperties
    range: datetime
    required: true
  text:
    name: text
    description: Narrative text content
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    alias: text
    owner: NarrativeEntryProperties
    domain_of:
    - NarrativeEntryProperties
    - TextAnnotationProperties
    - MCPContentItem
    range: string
    required: true
  track_id:
    name: track_id
    description: Associated track identifier (optional)
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    alias: track_id
    owner: NarrativeEntryProperties
    domain_of:
    - NarrativeEntryProperties
    range: string
  symbol:
    name: symbol
    description: Display symbol code from REP file
    from_schema: https://debrief.info/schemas/annotations
    alias: symbol
    owner: NarrativeEntryProperties
    domain_of:
    - PositionStyle
    - PositionStyleOverride
    - ReferenceLocationProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    range: string
  style:
    name: style
    description: Point styling properties for display position
    from_schema: https://debrief.info/schemas/annotations
    alias: style
    owner: NarrativeEntryProperties
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    range: PointProperties
    required: true
  tags:
    name: tags
    description: Free-text labels assigned to this feature by the analyst
    from_schema: https://debrief.info/schemas/common
    rank: 1000
    alias: tags
    owner: NarrativeEntryProperties
    domain_of:
    - BaseFeatureProperties
    - VertexMetadata
    - StacExtensionProperties
    - StacItemSummary
    range: string
    required: false
    multivalued: true
  visible:
    name: visible
    description: Whether this feature is shown on the map. Absent or true means visible;
      false means hidden. Replaces the session sidecar's hiddenFeatureIds denylist
      (feature 261). Per-feature visibility travels with the feature inside features.geojson.
    from_schema: https://debrief.info/schemas/common
    rank: 1000
    alias: visible
    owner: NarrativeEntryProperties
    domain_of:
    - BaseFeatureProperties
    - SensorContact
    - SensorData
    range: boolean
    required: false
  provenance:
    name: provenance
    description: PROV-aligned provenance records (append-only log of tool operations)
    from_schema: https://debrief.info/schemas/common
    rank: 1000
    alias: provenance
    owner: NarrativeEntryProperties
    domain_of:
    - BaseFeatureProperties
    - SystemStateProperties
    - SystemRecordProperties
    range: LogEntry
    multivalued: true
    inlined: true
    inlined_as_list: true
  vertex_metadata:
    name: vertex_metadata
    description: 'Sparse list of per-vertex metadata, keyed by `path`. Empty arrays
      MUST be omitted from the serialised feature (FR-010). Duplicate `path` values
      MUST be rejected by validators (contract §Cross-cutting #3). Every concrete
      subclass of `BaseFeatureProperties` gains this slot by inheritance  see spec
      #192, contracts/vertex-metadata-slot.md.'
    from_schema: https://debrief.info/schemas/common
    rank: 1000
    alias: vertex_metadata
    owner: NarrativeEntryProperties
    domain_of:
    - BaseFeatureProperties
    range: VertexMetadata
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true