Class Span

Ztag

html/element/span

Zparents

html/element/**

Zicon

html

Hierarchy (view full)

Accessors

disposed elementsResolved lockedResolved

Constructors

constructor

Methods

addBehavior appendChild constructChildren dispose getBehavior getBehaviors getZComponentInstance register remove removeBehavior removeChild unregister

Other

tags

Properties - Behavior

enabled

Properties - Other

behaviors children classList contextManager display element enabledResolved flexDirection id innerText locked? onClick onDispose parent?

Properties - Position

bottom left position right top

Properties - Size

height width

Properties - Spacing

marginBottom marginLeft marginRight marginTop paddingBottom paddingLeft paddingRight paddingTop

Accessors

disposed

  • get disposed(): boolean

  • Gets the disposed status of the entity.

    Returns boolean

    The disposed status.

elementsResolved

  • get elementsResolved(): any[]

  • An array of the elements that this component instance exposes. In the case that this component does not expose any elements of its own, this will be an array of the elements exposed by this component's children.

    Returns any[]

lockedResolved

  • get lockedResolved(): boolean

  • Returns true if this component, or any of its parents, are marked as locked.

    Returns boolean

Constructors

constructor

Methods

addBehavior

  • addBehavior(b): void

  • Adds a behavior to the component.

    Parameters

    • b: Behavior<Component<any, ConstructorProps>>

      The behavior to add.

    Returns void

appendChild

constructChildren

  • constructChildren(children, contextManager?): void

  • Constructs the children of this component.

    Parameters

    • children: ComponentChildren
    • OptionalcontextManager: ContextManager

    Returns void

dispose

getBehavior

  • getBehavior<T>(type): undefined | InstanceType<T>

  • Gets a behavior of a specific type from the component.

    Type Parameters

    • T extends (new (contextManager: ContextManager, instance: Component<any, ConstructorProps>, ...args: any[]) => Behavior<Component<any, ConstructorProps>>)

      The behavior type.

    Parameters

    • type: T

      The type of behavior to get.

    Returns undefined | InstanceType<T>

    The behavior of the specified type, or undefined if no such behavior exists.

getBehaviors

  • getBehaviors<T>(type): InstanceType<T>[]

  • Gets all behaviors of a specific type from the component.

    Type Parameters

    • T extends (new (contextManager: ContextManager, instance: Component<any, ConstructorProps>, ...args: any[]) => Behavior<Component<any, ConstructorProps>>)

      The behavior type.

    Parameters

    • type: T

      The type of behaviors to get.

    Returns InstanceType<T>[]

    An array of behaviors of the specified type.

getZComponentInstance

  • getZComponentInstance<T>(type?): T

  • Get the instance of the ZComponent that constructed this entity.

    If you pass the class of a ZComponent as the type parameter, this function will ensure that it returns an instance of that ZComponent. If this component or behavior was constructed by a different ZComponent class, or by a different entity altogether, the function with throw an error.

    Type Parameters

    • T extends ZComponent<any, T> = ZComponent<any>

    Parameters

    • Optionaltype: ConstructorForComponent<T>

      The ZComponent class that you are expecting to receive

    Returns T

    The instance of the ZComponent that constructed this component or behavior

register

  • register<Args>(evt, fn, priority?): any

  • Register a function to be called when an Event is fired, or an Observable's value changes. The function will only be bound to the underlying Event or Observable while this entity is enabled.

    Using this function, rather than attaching your handler directly to the Event or Observable, ensures your handler is automatically released when this entity is disposed.

    Type Parameters

    • Args extends any[]

    Parameters

    • evt: Event<Args>

      The Event or Observable to listen to

    • fn: ((...args: Args) => void)

      A function that will be called when the event fires, or the Observable value changes

        • (...args): void

        • Parameters

          Returns void

    • Optionalpriority: number

    Returns any

  • register<Args>(evt, fn, options?): any

  • Type Parameters

    • Args extends any[]

    Parameters

    Returns any

  • register<Type>(observable, fn, priority?): any

  • Type Parameters

    • Type

    Parameters

    • observable: Observable<Type, never>
    • fn: ((v: Type) => void)
        • (v): void

        • Parameters

          Returns void

    • Optionalpriority: number

    Returns any

  • register<Type>(observable, fn, options?): any

  • Type Parameters

    • Type

    Parameters

    Returns any

remove

  • remove(): void

  • Removes this component from its parent component.

    Returns void

removeBehavior

  • removeBehavior(b): void

  • Removes a behavior from the component.

    Parameters

    • b: Behavior<Component<any, ConstructorProps>>

      The behavior to remove.

    Returns void

removeChild

  • removeChild(c): void

  • Removes the supplied component instance from the list of children.

    Parameters

    • c: Component<any, ConstructorProps>

      The component to remove

    Returns void

unregister

  • unregister<Args>(evt, fn): any

  • Unregisters a function that was previously registered to an Event or Observable.

    Type Parameters

    • Args extends any[]

    Parameters

    • evt: Event<Args>

      The Event or Observable

    • fn: ((...args: Args) => void)

      The function that was passed in the call to register

        • (...args): void

        • Parameters

          Returns void

    Returns any

  • unregister<Type>(observable, fn): any

  • Type Parameters

    • Type

    Parameters

    • observable: Observable<Type, never>
    • fn: ((v: Type) => void)
        • (v): void

        • Parameters

          Returns void

    Returns any

Other

Readonlytags

tags: Observable<string[], never>

An array of string 'tags' assocated with this component.

The getComponentsByTag(mgr, tag) function can be used to get an array of components with the supplied tag.

By default, tags are scoped to the ZComponent instance that a component is constructed by. Tags that begin with global: are scoped to the experience as a whole.

Zprop

Zgrouppriority

0

Properties - Behavior

Readonlyenabled

enabled: Observable<boolean, never>

If false, this entity and its children will no longer participate in the experience.

Note - to read this value, you may wish to use enabledResolved which will be false if this entity, or any of its parents, have enabled set to false.

The precise implications of enabled being false will vary between entities, but in general disabled entities:

  • should not emit any events,
  • should not take any action, e.g. navigate the user to a different page,
  • should not perform any network communication,
  • should not make changes to other behaviors or components in the experience,
  • should minimise any runtime performance cost (e.g. detach from any frame handlers).

Zprop

Zdefault

true

Zgrouppriority

10

Properties - Other

Readonlybehaviors

behaviors: Behavior<Component<any, ConstructorProps>>[]

The behaviors attached to this component.

Readonlychildren

children: Component<any, ConstructorProps>[]

The children of this component.

classList

classList: Observable<string[], never> = ...

Zprop

ReadonlycontextManager

contextManager: ContextManager

display

display: Observable<undefined | CSSDisplay, never> = ...

Zprop

element

element: HTMLSpanElement

ReadonlyenabledResolved

enabledResolved: Observable<boolean, never>

This will have value false if this entity, or any of its parents, have enabled set to false.

To change the enabled status of this entity, use the enabled property instead.

The precise implications of enabled being false will vary between entities, but in general disabled entities:

  • should not emit any events,
  • should not take any action, e.g. navigate the user to a different page,
  • should not perform any network communication,
  • should not make changes to other behaviors or components in the experience,
  • should minimise any runtime performance cost.

Disabled entities will typically remain visible (if they have a visible appearance).

flexDirection

flexDirection: Observable<CSSFlexDirection, never> = ...

Zprop

Zdefault

row

id

id: Observable<string, never> = ...

Zprop

innerText

innerText: Observable<string, never> = ...

Zprop

Ztype

text-multiline

Zgrouppriority

21

Optionallocked

locked?: boolean

If true, this component can't be selected at design time in the 3D preview.

onClick

onClick: Event<[MouseEvent]> = ...

Zprop

ReadonlyonDispose

onDispose: Event<[]>

An event that is fired as the last act of this entity being destroyed.

Optionalparent

parent?: Component<any, ConstructorProps>

The parent of this component.

Properties - Position

bottom

bottom: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

left

left: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

position

position: Observable<CSSPosition, never> = ...

Zprop

Zdefault

static

right

right: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

top

top: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

Properties - Size

height

height: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

width

width: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

Properties - Spacing

marginBottom

marginBottom: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

marginLeft

marginLeft: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

marginRight

marginRight: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

marginTop

marginTop: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

paddingBottom

paddingBottom: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

paddingLeft

paddingLeft: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

paddingRight

paddingRight: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

paddingTop

paddingTop: Observable<undefined | [number, CSSLengthUnit], never> = ...

Zprop

Zdefault

[0, "px"]

Settings

Member Visibility

On This Page

disposedelementsResolvedlockedResolvedconstructoraddBehaviorappendChildconstructChildrendisposegetBehaviorgetBehaviorsgetZComponentInstanceregisterremoveremoveBehaviorremoveChildunregistertagsenabledbehaviorschildrenclassListcontextManagerdisplayelementenabledResolvedflexDirectionidinnerTextlockedonClickonDisposeparentbottomleftpositionrighttopheightwidthmarginBottommarginLeftmarginRightmarginToppaddingBottompaddingLeftpaddingRightpaddingTop