Class: FlightInstanceItem

vcs.vcm.widgets.legend.FlightInstanceItem

Class representing a leaf node within a tree widget, managing a flight.

new vcs.vcm.widgets.legend.FlightInstanceItem(options)

Name Type Description
options vcs.vcm.widgets.legend.FlightInstanceItem.Options

Extends

Members

allowPlayer{boolean}

Whether the {@see vcs.vcm.util.flight.FlightPlayer} can be rendered under this item

className{string}

class Name of the Object

The instance being tracked

id{string}

The unique id of the given item

level{number}

The nesting level of this tree item

titleObject{Object}

Translateable title object. Where the key represents the local, and the value the translation for example: { en: 'Example', de: 'Beispiel' }

visible{boolean}

Whether the item should be displayed

Methods

activate(active, ignoreViewpoint) inherited

Activates the tree item

Name Type Description
active boolean

the state to activate to, false will deactivate

ignoreViewpoint boolean

if there is a viewpoint set, it is not activated

getViewPoint(){vcs.vcm.util.ViewPoint|null} inherited

returns the viewpoint for this treeitem

Deprecated
  • v3.6

    gotoViewpoint() inherited

    Goes to this tree items viewpoint, if there is one defined

    Type Definitions

    vcs.vcm.widgets.legend.FlightInstanceItem.Options{vcs.vcm.widgets.legend.TreeItem.Options}

    Properties:
    Name Type Argument Default Description
    flightInstance vcs.vcm.util.flight.FlightInstance | undefined

    if created at runtime, pass an instance directly

    flightName string | undefined

    the name of a flight in the config

    allowPlayer boolean <optional>
    false

    allow the {@see vcs.vcm.util.flight.FlightPlayer} to be rendered under this item