Class: PolyAnnotationProperties¶

Properties for a PolyAnnotation

URI: debrief:class/PolyAnnotationProperties

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

      PolyAnnotationProperties : kind





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



      PolyAnnotationProperties : label

      PolyAnnotationProperties : line_number

      PolyAnnotationProperties : provenance





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



      PolyAnnotationProperties : style





        PolyAnnotationProperties --> "1" PolygonProperties : style
        click PolygonProperties href "../../classes/PolygonProperties/"



      PolyAnnotationProperties : symbol

      PolyAnnotationProperties : tags

      PolyAnnotationProperties : vertex_count

      PolyAnnotationProperties : vertex_metadata





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



      PolyAnnotationProperties : visible

Inheritance¶

BaseFeatureProperties
- PolyAnnotationProperties

Slots¶

Name	Cardinality and Range	Description	Inheritance
kind	1 FeatureKindEnum	Feature type discriminator	direct
vertex_count	1 Integer	Number of unique vertices (excluding ring closure point)	direct
label	0..1 String	Annotation label text	direct
symbol	0..1 String	Display symbol code from REP file	direct
style	1 PolygonProperties	Polygon styling properties for the polygon area	direct
line_number	0..1 Integer	Source line number for debugging	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
PolyAnnotation	properties	range	PolyAnnotationProperties

Identifier and Mapping Information¶

Schema Source¶

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

Mappings¶

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

LinkML Source¶

Direct¶

name: PolyAnnotationProperties
description: Properties for a PolyAnnotation
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: POLY
  vertex_count:
    name: vertex_count
    description: Number of unique vertices (excluding ring closure point)
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    domain_of:
    - PolyAnnotationProperties
    range: integer
    required: true
    minimum_value: 3
  label:
    name: label
    description: Annotation label text
    from_schema: https://debrief.info/schemas/annotations
    domain_of:
    - VertexMetadata
    - PositionStyleOverride
    - SensorContact
    - TUASolution
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - ToolResultAnnotations
    - DatasetAxisMetadata
  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: Polygon styling properties for the polygon area
    from_schema: https://debrief.info/schemas/annotations
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    range: PolygonProperties
    required: true
  line_number:
    name: line_number
    description: Source line number for debugging
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    domain_of:
    - PolyAnnotationProperties
    range: integer

Induced¶

name: PolyAnnotationProperties
description: Properties for a PolyAnnotation
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: PolyAnnotationProperties
    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: POLY
  vertex_count:
    name: vertex_count
    description: Number of unique vertices (excluding ring closure point)
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    alias: vertex_count
    owner: PolyAnnotationProperties
    domain_of:
    - PolyAnnotationProperties
    range: integer
    required: true
    minimum_value: 3
  label:
    name: label
    description: Annotation label text
    from_schema: https://debrief.info/schemas/annotations
    alias: label
    owner: PolyAnnotationProperties
    domain_of:
    - VertexMetadata
    - PositionStyleOverride
    - SensorContact
    - TUASolution
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - ToolResultAnnotations
    - DatasetAxisMetadata
    range: string
  symbol:
    name: symbol
    description: Display symbol code from REP file
    from_schema: https://debrief.info/schemas/annotations
    alias: symbol
    owner: PolyAnnotationProperties
    domain_of:
    - PositionStyle
    - PositionStyleOverride
    - ReferenceLocationProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    range: string
  style:
    name: style
    description: Polygon styling properties for the polygon area
    from_schema: https://debrief.info/schemas/annotations
    alias: style
    owner: PolyAnnotationProperties
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    range: PolygonProperties
    required: true
  line_number:
    name: line_number
    description: Source line number for debugging
    from_schema: https://debrief.info/schemas/annotations
    rank: 1000
    alias: line_number
    owner: PolyAnnotationProperties
    domain_of:
    - PolyAnnotationProperties
    range: integer
  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: PolyAnnotationProperties
    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: PolyAnnotationProperties
    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: PolyAnnotationProperties
    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: PolyAnnotationProperties
    domain_of:
    - BaseFeatureProperties
    range: VertexMetadata
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true