Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AvOriginProps

Props for AvOrigin

Hierarchy

Index

Properties

Properties

Optional debugName

debugName: string

A name that's applied to the node in the monitor and other tools. This name has no effect at runtime.

Optional id

id: string

This is the ID of the DOM element that is created as the parent of the component. It is used to reference other nodes in the gadget. If it is specified, it must be unique within the gadget.

default

none

Optional onIdAssigned

onIdAssigned: (addr: EndpointAddr) => void

Set this prop to be notified when the node is assigned its endpoint address. This is not necessary for most nodes.

Type declaration

    • (addr: EndpointAddr): void

    • Parameters

      • addr: EndpointAddr

      Returns void

path

path: string

The path to reparent any children to.

Reasonable values are:

  • /user/head
  • /user/hand/right
  • /user/hand/left

Optional persistentName

persistentName: string

An alias for debugName.

deprecated

Optional visible

visible: boolean

Controls whether or not this node and its children are visible. If retaining the state of a node is important as it comes and goes, use the visible prop instead of omitting the node from the render function. This allows the renderer to retain the node's state even when you don't want it to draw.

default

true

Generated using TypeDoc