Class: StoryboardProperties¶

Properties class for a Storyboard parent Feature. A Storyboard is a named, ordered collection of Scenes attached to a single plot.

URI: debrief:class/StoryboardProperties

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

      StoryboardProperties : description

      StoryboardProperties : id

      StoryboardProperties : kind





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



      StoryboardProperties : name

      StoryboardProperties : provenance





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



      StoryboardProperties : schema_version

      StoryboardProperties : tags

Inheritance¶

BaseFeatureProperties
- StoryboardProperties

Slots¶

Name	Cardinality and Range	Description	Inheritance
kind	1 FeatureKindEnum	Feature kind discriminator (pinned to STORYBOARD)	direct
id	1 String	ULID (26 chars, Crockford base-32)	direct
name	1 String	Display title	direct
description	0..1 String	Markdown narrative description	direct
schema_version	1 Integer	Schema version	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
StoryboardFeature	properties	range	StoryboardProperties

Identifier and Mapping Information¶

Schema Source¶

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

Mappings¶

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

LinkML Source¶

Direct¶

name: StoryboardProperties
description: Properties class for a Storyboard parent Feature. A Storyboard is a named,
  ordered collection of Scenes attached to a single plot.
from_schema: https://debrief.info/schemas/debrief
is_a: BaseFeatureProperties
attributes:
  kind:
    name: kind
    description: Feature kind discriminator (pinned to STORYBOARD)
    from_schema: https://debrief.info/schemas/storyboard
    domain_of:
    - BaseFeatureProperties
    - TrackProperties
    - ReferenceLocationProperties
    - SystemStateProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - SelectionRequirement
    - SystemRecordProperties
    - StoryboardProperties
    - SceneProperties
    range: FeatureKindEnum
    required: true
    equals_string: STORYBOARD
  id:
    name: id
    description: ULID (26 chars, Crockford base-32). Immutable after create.
    from_schema: https://debrief.info/schemas/storyboard
    domain_of:
    - TrackFeature
    - ReferenceLocation
    - SystemState
    - MultiPointFeature
    - MultiPolygonFeature
    - NarrativeEntry
    - CircleAnnotation
    - RectangleAnnotation
    - LineAnnotation
    - TextAnnotation
    - VectorAnnotation
    - PolyAnnotation
    - Tool
    - PlatformRecord
    - PlotSummary
    - StacItemSummary
    - GeoJSONFeature
    - StoryboardProperties
    - SceneProperties
    - StoryboardFeature
    - SceneFeature
    range: string
    required: true
    pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
  name:
    name: name
    description: Display title. Non-empty. Unique within plot FeatureCollection.
    from_schema: https://debrief.info/schemas/storyboard
    domain_of:
    - SegmentMetadata
    - SensorData
    - TUAData
    - PointMetadataEntry
    - ReferenceLocationProperties
    - Tool
    - ToolParameter
    - PlatformRecord
    - LevelDefinition
    - DatasetSeries
    - StoryboardProperties
    range: string
    required: true
  description:
    name: description
    description: Markdown narrative description
    from_schema: https://debrief.info/schemas/storyboard
    domain_of:
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - Tool
    - ToolParameter
    - LevelDefinition
    - StoryboardProperties
    - SceneProperties
    range: string
    required: false
  schema_version:
    name: schema_version
    description: Schema version. Starts at 1. Monotonically non-decreasing across
      edits; bumped only by migrations.
    from_schema: https://debrief.info/schemas/storyboard
    rank: 1000
    domain_of:
    - StoryboardProperties
    range: integer
    required: true
    minimum_value: 1

Induced¶

name: StoryboardProperties
description: Properties class for a Storyboard parent Feature. A Storyboard is a named,
  ordered collection of Scenes attached to a single plot.
from_schema: https://debrief.info/schemas/debrief
is_a: BaseFeatureProperties
attributes:
  kind:
    name: kind
    description: Feature kind discriminator (pinned to STORYBOARD)
    from_schema: https://debrief.info/schemas/storyboard
    alias: kind
    owner: StoryboardProperties
    domain_of:
    - BaseFeatureProperties
    - TrackProperties
    - ReferenceLocationProperties
    - SystemStateProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - SelectionRequirement
    - SystemRecordProperties
    - StoryboardProperties
    - SceneProperties
    range: FeatureKindEnum
    required: true
    equals_string: STORYBOARD
  id:
    name: id
    description: ULID (26 chars, Crockford base-32). Immutable after create.
    from_schema: https://debrief.info/schemas/storyboard
    alias: id
    owner: StoryboardProperties
    domain_of:
    - TrackFeature
    - ReferenceLocation
    - SystemState
    - MultiPointFeature
    - MultiPolygonFeature
    - NarrativeEntry
    - CircleAnnotation
    - RectangleAnnotation
    - LineAnnotation
    - TextAnnotation
    - VectorAnnotation
    - PolyAnnotation
    - Tool
    - PlatformRecord
    - PlotSummary
    - StacItemSummary
    - GeoJSONFeature
    - StoryboardProperties
    - SceneProperties
    - StoryboardFeature
    - SceneFeature
    range: string
    required: true
    pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
  name:
    name: name
    description: Display title. Non-empty. Unique within plot FeatureCollection.
    from_schema: https://debrief.info/schemas/storyboard
    alias: name
    owner: StoryboardProperties
    domain_of:
    - SegmentMetadata
    - SensorData
    - TUAData
    - PointMetadataEntry
    - ReferenceLocationProperties
    - Tool
    - ToolParameter
    - PlatformRecord
    - LevelDefinition
    - DatasetSeries
    - StoryboardProperties
    range: string
    required: true
  description:
    name: description
    description: Markdown narrative description
    from_schema: https://debrief.info/schemas/storyboard
    alias: description
    owner: StoryboardProperties
    domain_of:
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - Tool
    - ToolParameter
    - LevelDefinition
    - StoryboardProperties
    - SceneProperties
    range: string
    required: false
  schema_version:
    name: schema_version
    description: Schema version. Starts at 1. Monotonically non-decreasing across
      edits; bumped only by migrations.
    from_schema: https://debrief.info/schemas/storyboard
    rank: 1000
    alias: schema_version
    owner: StoryboardProperties
    domain_of:
    - StoryboardProperties
    range: integer
    required: true
    minimum_value: 1
  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: StoryboardProperties
    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: StoryboardProperties
    domain_of:
    - BaseFeatureProperties
    - SystemStateProperties
    - SystemRecordProperties
    range: LogEntry
    multivalued: true
    inlined: true
    inlined_as_list: true