Skip to content

Use Viewport component

Common example:

html
<Viewport worldWidth="2000" worldHeight="2000" clamp={ {direction: 'all'} } />

Properties

You can use all properties from Display Object

Viewport Follow Directive

The viewportFollow directive allows an element to be followed by the viewport. When applied, the viewport will automatically center on the element as it moves.

This directive must be used within a Viewport component context.

Usage

html
<Viewport worldWidth="2000" worldHeight="2000" clamp={ {direction: 'all'} />
    <Rect viewportFollow x="0" y="0" width="100" height="100" color="red" />
</Viewport>

In this example, the red rectangle will be followed by the viewport, keeping it centered in the view as it moves around within the 2000x2000 world space.

Requirements

  • Must be used on an element that is a child of a Viewport component
  • The parent Viewport component must have defined dimensions (worldWidth and worldHeight)

Common Properties

PropertyTypeDescription
xnumberX-coordinate position of the display object.
ynumberY-coordinate position of the display object.
widthnumberWidth of the display object.
heightnumberHeight of the display object.
scaleobjectScale of the display object.
anchorobjectAnchor point of the display object.
skewobjectSkew of the display object.
tintnumberTint color of the display object.
rotationnumberRotation of the display object in radians.
anglenumberRotation of the display object in degrees.
zIndexnumberZ-index of the display object.
roundPixelsbooleanWhether to round pixel values.
cursorstringCursor style when hovering over the display object.
visiblebooleanVisibility of the display object.
alphanumberAlpha transparency of the display object.
pivotobjectPivot point of the display object.
flexDirectionstringFlex direction for layout. Possible values: 'row', 'column', 'row-reverse', 'column-reverse'.
flexWrapstringFlex wrap for layout. Possible values: 'wrap', 'nowrap', 'wrap-reverse'.
justifyContentstringJustify content for layout. Possible values: 'flex-start', 'flex-end', 'center', 'space-between', 'space-around'.
alignItemsstringAlign items for layout. Possible values: 'auto', 'flex-start', 'flex-end', 'center', 'stretch', 'baseline', 'space-between', 'space-around'.
alignContentstringAlign content for layout. Possible values: 'flex-start', 'flex-end', 'center', 'stretch', 'baseline', 'space-between', 'space-around'.
alignSelfstringAlign self for layout. Possible values: 'auto', 'flex-start', 'flex-end', 'center', 'stretch', 'baseline', 'space-between', 'space-around'.
marginobjectMargin for layout.
paddingobjectPadding for layout.
gapobjectGap for layout.
borderobjectBorder for layout.
positionTypestringPosition type for layout.
filtersarrayFilters applied to the display object.
maskOfElementElement that this display object masks.
blendModestringBlend mode for rendering.
filterAreaobjectFilter area for rendering.

shadow

PropertyTypeDescription
PropertyTypeDescription
blurnumberBlur strength.
colornumberColor of the shadow.
offsetobjectOffset of the shadow.
qualitynumberQuality of the shadow.