Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutlineTag

class

OutlineTag

classdesc

Tag holding properties for visualizing a geometry outline.

example
var geometry = new Mapillary.TagComponent.RectGeometry([0.3, 0.3, 0.5, 0.4]);
var tag = new Mapillary.TagComponent.OutlineTag(
    "id-1",
    geometry
    { editable: true, lineColor: 0xff0000 });

tagComponent.add([tag]);

Hierarchy

  • Tag
    • OutlineTag

Index

Constructors

constructor

Events

Static changed

changed: string = "changed"

Event fired when a property related to the visual appearance of the tag has changed.

type

{Tag} The tag instance that has changed.

Static click

click: string = "click"

Event fired when the icon of the outline tag is clicked.

type

{OutlineTag} The tag instance that was clicked.

Static geometrychanged

geometrychanged: string = "geometrychanged"

Event fired when the geometry of the tag has changed.

type

{Tag} The tag instance whose geometry has changed.

Accessors

click$

domain

  • get domain(): TagDomain
  • Get domain property.

    description

    Readonly property that can only be set in constructor.

    Returns TagDomain

    Value indicating the domain of the tag.

editable

  • get editable(): boolean
  • set editable(value: boolean): void

fillColor

  • get fillColor(): number
  • set fillColor(value: number): void

fillOpacity

  • get fillOpacity(): number
  • set fillOpacity(value: number): void

geometry

icon

  • get icon(): string
  • set icon(value: string): void

iconFloat

iconIndex

  • get iconIndex(): number
  • set iconIndex(value: number): void

id

  • get id(): string

indicateVertices

  • get indicateVertices(): boolean
  • set indicateVertices(value: boolean): void
  • Get indicate vertices property.

    Returns boolean

    Value indicating if vertices should be indicated when tag is editable.

  • Set indicate vertices property.

    fires

    Tag#changed

    Parameters

    • value: boolean

    Returns void

    Value indicating if vertices should be indicated when tag is editable.

lineColor

  • get lineColor(): number
  • set lineColor(value: number): void

lineOpacity

  • get lineOpacity(): number
  • set lineOpacity(value: number): void

lineWidth

  • get lineWidth(): number
  • set lineWidth(value: number): void

text

  • get text(): string
  • set text(value: string): void

textColor

  • get textColor(): number
  • set textColor(value: number): void

Methods

fire

  • fire(eventType: string, data: any): void
  • Parameters

    • eventType: string
    • data: any

    Returns void

off

  • off(eventType: string, fn: any): void
  • Unsubscribe from an event by its name.

    Parameters

    • eventType: string

      The name of the event to subscribe to.

    • fn: any

      The handler to remove.

    Returns void

on

  • on(eventType: string, fn: any): void
  • Subscribe to an event by its name.

    Parameters

    • eventType: string

      The name of the event to subscribe to.

    • fn: any

      The handler called when the event occurs.

    Returns void

setOptions

Generated using TypeDoc