Class: TextAnnotationProperties¶

Properties for a TextAnnotation

URI: debrief:class/TextAnnotationProperties

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

      TextAnnotationProperties : kind





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



      TextAnnotationProperties : provenance





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



      TextAnnotationProperties : style





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



      TextAnnotationProperties : symbol

      TextAnnotationProperties : tags

      TextAnnotationProperties : text

Inheritance¶

BaseFeatureProperties
- TextAnnotationProperties

Slots¶

Name	Cardinality and Range	Description	Inheritance
kind	1 FeatureKindEnum	Feature type discriminator	direct
text	1 String	Text content to display	direct
symbol	0..1 String	Display symbol code from REP file	direct
style	1 PointProperties	Point styling properties for the text position marker	direct
tags	* String	Free-text labels assigned to this feature by the analyst	BaseFeatureProperties
provenance	* LogEntry	PROV-aligned provenance records (append-only log of tool operations)	BaseFeatureProperties

Usages¶

used by	used in	type	used
TextAnnotation	properties	range	TextAnnotationProperties

Identifier and Mapping Information¶

Schema Source¶

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

Mappings¶

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

LinkML Source¶

Direct¶

name: TextAnnotationProperties
description: Properties for a TextAnnotation
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
    range: FeatureKindEnum
    required: true
    equals_string: TEXT
  text:
    name: text
    description: Text content to display
    from_schema: https://debrief.info/schemas/annotations
    domain_of:
    - NarrativeEntryProperties
    - TextAnnotationProperties
    required: true
  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 the text position marker
    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: TextAnnotationProperties
description: Properties for a TextAnnotation
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: TextAnnotationProperties
    domain_of:
    - BaseFeatureProperties
    - TrackProperties
    - ReferenceLocationProperties
    - SystemStateProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - SelectionRequirement
    - SystemRecordProperties
    range: FeatureKindEnum
    required: true
    equals_string: TEXT
  text:
    name: text
    description: Text content to display
    from_schema: https://debrief.info/schemas/annotations
    alias: text
    owner: TextAnnotationProperties
    domain_of:
    - NarrativeEntryProperties
    - TextAnnotationProperties
    range: string
    required: true
  symbol:
    name: symbol
    description: Display symbol code from REP file
    from_schema: https://debrief.info/schemas/annotations
    alias: symbol
    owner: TextAnnotationProperties
    domain_of:
    - PositionStyle
    - PositionStyleOverride
    - ReferenceLocationProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    range: string
  style:
    name: style
    description: Point styling properties for the text position marker
    from_schema: https://debrief.info/schemas/annotations
    alias: style
    owner: TextAnnotationProperties
    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: TextAnnotationProperties
    domain_of:
    - BaseFeatureProperties
    - StacExtensionProperties
    - StacItemSummary
    range: string
    required: false
    multivalued: true
  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: TextAnnotationProperties
    domain_of:
    - BaseFeatureProperties
    - SystemStateProperties
    - SystemRecordProperties
    range: LogEntry
    multivalued: true
    inlined: true
    inlined_as_list: true