The HtmlObject adds a regular HTML element to the display list. You can set all the well known DisplayObject properties like x, y, scaleX, scaleY, rotation or alpha which will be applied to the HTML element. Because the HtmlObject is still rendered by the browser it will appear on top of the Stage and can't be overlayed by regular DisplayObjects.

Please use this HTML configuration to get the correct results:

<div style="position: relative;">
  <canvas id="stage" width="800" height="600"></canvas>
  <div id="htmlObject">Hello World</div>
</div>

The HtmlObject will automatically set the following CSS properties for the element to control it's position and opacity:

position: absolute;
left: 0px;
top: 0px;
transformOrigin: 0% 0% 0;
opacity: (htmlObject.alpha)
visibility: (htmlObject.visible)
transform: (htmlObject.transformationMatrix)

Example:

var element = html.querySelector("#htmlObject");
var htmlObject = new HtmlObject(element);
htmlObject.x = 400;
htmlObject.y = 300;
stage.addChild(htmlObject);
Inheritance

Constructors

HtmlObject(Element element)

Properties

alpha → num

The alpha transparency value of the object specified.

read / write, inherited
blendMode → BlendMode

A value from the BlendMode class that specifies which blend mode to use.

read / write, inherited
bounds → Rectangle<num>

Returns a rectangle that defines the area of this display object in this display object's local coordinates.

read-only, inherited
boundsTransformed → Rectangle<num>

Returns a rectangle that defines the area of this display object in this display object's parent coordinates.

read-only, inherited
cache → RenderTextureQuad

This getter gives you access to the underlying RenderTextureQuad if a cache is applied to this display object. If no cache is applied this value is ´null´.

read-only, inherited
displayObjectID → int

read-only, inherited
element → Element

read-only
filters → List<BitmapFilter>

The filters currently associated with this display object.

read / write, inherited
globalTransformationMatrix → Matrix

The global 2D transformation matrix of this display object.

read-only, inherited
globalTransformationMatrix3D → Matrix3D

The global 3D transformation matrix of this display object.

read-only, inherited
hashCode → int

Get a hash code for this object.

read-only, inherited
height → num

The height of this display object with the applied transformation.

read / write, inherited
mask → Mask

The calling display object is masked by the specified mask object.

read / write, inherited
mousePosition → Point<num>

The position of the mouse relative to the local coordinate system of the display object.

read-only, inherited
mouseX → num

The x-coordinate of the mouse relative to the local coordinate system of the display object.

read-only, inherited
mouseY → num

The y-coordinate of the mouse relative to the local coordinate system of the display object.

read-only, inherited
name → String

The instance name of this display object.

read / write, inherited
off → bool

write-only
onAdded → EventStream<Event>

Dispatched when a display object is added to the display list.

read-only, inherited
onAddedToStage → EventStream<Event>

Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.

read-only, inherited
onEnterFrame → EventStream<EnterFrameEvent>

Dispatched when a frame is entered.

read-only, inherited
onExitFrame → EventStream<ExitFrameEvent>

Dispatched when a frame is exited. All frame scripts have been run.

read-only, inherited
onRemoved → EventStream<Event>

Dispatched when a display object is about to be removed from the display list.

read-only, inherited
onRemovedFromStage → EventStream<Event>

Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.

read-only, inherited
onRender → EventStream<RenderEvent>

Dispatched when the display list is about to be updated and rendered.

read-only, inherited
parent → DisplayObjectParent

The DisplayObjectContainer object that contains this display object.

read-only, inherited
pivotX → num

The x-coordinate of the pivot point of this display object.

read / write, inherited
pivotY → num

The y-coordinate of the pivot point of this display object.

read / write, inherited
root → DisplayObject

The top-most display object in the portion of the display list's tree structure.

read-only, inherited
rotation → num

The rotation of this display object, in radians, from its original orientation.

read / write, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited
scaleX → num

The horizontal scale (percentage) of the object as applied from the pivot point.

read / write, inherited
scaleY → num

The vertical scale (percentage) of the object as applied from the pivot point.

read / write, inherited
skewX → num

The horizontal skew of this object.

read / write, inherited
skewY → num

The vertical skew of this object.

read / write, inherited
stage → Stage

The Stage of this display object.

read-only, inherited
transformationMatrix → Matrix

The transformation matrix of this display object relative to this display object's parent.

read-only, inherited
userData → dynamic

The user-defined data associated with this display object.

read / write, inherited
visible → bool

write-only
width → num

The width of this display object with the applied transformation.

read / write, inherited
x → num

The x-coordinate of is display object relative to the local coordinates of the parent DisplayObjectContainer.

read / write, inherited
y → num

The y-coordinate of this display object relative to the local coordinates of the parent DisplayObjectContainer.

read / write, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

addEventListener(String eventType, EventListener eventListener, { bool useCapture: false, int priority: 0 }) → StreamSubscription<Event>

Adds an event listener to receive events.

inherited
addTo(DisplayObjectParent parent) → void

Add this display object to the specified parent.

inherited
alignPivot([HorizontalAlign hAlign = HorizontalAlign.Center, VerticalAlign vAlign = VerticalAlign.Center ]) → void

Aligns the display object's pivot point relative to the current bounds.

inherited
applyCache(num x, num y, num width, num height, { bool debugBorder: false, num pixelRatio: 1.0 }) → void

Draws the specified area of this display object to an internal render texture and the engine will use this texture to optimize performance.

inherited
dispatchEvent(Event event) → void

Dispatches the event to all listening subscribers.

inherited
dispatchEventRaw(Event event, EventDispatcher target, EventPhase eventPhase) → void

Do not use the dispatchEventRaw method unless you want to override the way how events are dispatched for display list object. Please use dispatchEvent instead.

inherited
getBounds(DisplayObject targetSpace) → Rectangle<num>

Returns the bounds of this display object relative to the specified targetSpace.

inherited
getTransformationMatrix(DisplayObject targetSpace) → Matrix

The 2D transformation matrix relative to the given targetSpace.

inherited
getTransformationMatrix3D(DisplayObject targetSpace) → Matrix3D

The 3D transformation matrix relative to the given targetSpace.

inherited
globalToLocal(Point<num> globalPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from the Stage's global coordinates to this display object's local coordinates.

inherited
hasEventListener(String eventType, { bool useCapture: false }) → bool

Returns true if the EventDispatcher has event listeners. The useCapture paramenter defines if the event listeners should be registered for the capturing event phase or not.

inherited
hitTestInput(num localX, num localY) → DisplayObject

Evaluates this display object to see if the coordinates localX and localY are inside this display object.

inherited
hitTestObject(DisplayObject other) → bool

Evaluates this display object to see if it overlaps or intersects with the bounding box of the other display object.

inherited
hitTestPoint(num x, num y, [ bool shapeFlag = false ]) → bool

Evaluates this display object to see if it overlaps or intersects with the point specified by the x and y parameters.

inherited
localToGlobal(Point<num> localPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from this display object's local coordinates to the Stage global coordinates.

inherited
localToParent(Point<num> localPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from this display object's local coordinates to this display object's parent coordinates.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
on<T extends Event>(String eventType) → EventStream<T>

Returns an event stream of type eventType.

inherited
parentToLocal(Point<num> parentPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from this display obejct's parent coordinates to this display object's local coordinates.

inherited
refreshCache() → void

Refreshes the cached area of this display object.

inherited
removeCache() → void

Removes the previously cached area of this display object.

inherited
removeEventListener(String eventType, EventListener eventListener, { bool useCapture: false }) → void

Removes an event listener to stop receiving events.

inherited
removeEventListeners(String eventType) → void

Removes all event listeners of a given event type.

inherited
removeFromParent() → void

Removes this display object from its parent.

inherited
render(RenderState renderState) → void

Renders this display object with the given renderState. The display object is rendered without its filters.

renderFiltered(RenderState renderState) → void

Renders this display object with the given renderState. The display object is rendered with its filters.

inherited
setTransform(num x, num y, [ num scaleX, num scaleY, num rotation, num skewX, num skewY, num pivotX, num pivotY ]) → void

Sets transformation properties.

inherited
toString() → String

Returns a string representation of this object.

inherited