Skip to content

Use NineSliceSprite component

html
<NineSliceSprite
  image="button.png"
  width={200}
  height={100}
  leftWidth={10}
  rightWidth={10}
  topHeight={10}
  bottomHeight={10}
  roundPixels={true}
/>

Properties

You can use all properties from Display Object plus the following:

PropertyTypeDescription
imagestringPath to the image file to be used as texture
textureTextureDirect texture object to use instead of image path
widthnumberTotal width of the nine-slice sprite
heightnumberTotal height of the nine-slice sprite
leftWidthnumberWidth of the left edge that should not be scaled
rightWidthnumberWidth of the right edge that should not be scaled
topHeightnumberHeight of the top edge that should not be scaled
bottomHeightnumberHeight of the bottom edge that should not be scaled
roundPixelsbooleanIf true, the sprite's position will be rounded to integers

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.