NineSlice
Hierarchy
- Graphic
- NineSlice
Index
Constructors
constructor
Parameters
config: NineSliceConfig
Returns NineSlice
Properties
readonlyid
publicopacity
Gets or sets the opacity of the graphic, 0 is transparent, 1 is solid (opaque).
publicshowDebug
Gets or sets wether to show debug information about the graphic
publicoptionaltint
publictransform
Accessors
publicflipHorizontal
Gets or sets the flipHorizontal, which will flip the graphic horizontally (across the y axis)
Returns boolean
Parameters
value: boolean
Returns void
publicflipVertical
Gets or sets the flipVertical, which will flip the graphic vertically (across the x axis)
Returns boolean
Parameters
value: boolean
Returns void
publicheight
Gets or sets the height of the graphic (always positive)
Returns number
Parameters
value: number
Returns void
publiclocalBounds
Gets a copy of the bounds in pixels occupied by the graphic on the the screen. This includes scale.
Returns BoundingBox
publicorigin
publicrotation
Gets or sets the rotation of the graphic
Returns number
Parameters
value: number
Returns void
publicscale
publicwidth
Gets or sets the width of the graphic (always positive)
Returns number
Parameters
value: number
Returns void
Methods
clone
Clones the 9 slice
Returns NineSlice
publiccloneGraphicOptions
Returns GraphicOptions
publicdraw
Draw the whole graphic to the context including transform
Parameters
ex: ExcaliburGraphicsContext
The excalibur graphics context
x: number
y: number
Returns void
getConfig
Returns the config of the 9 slice
Returns NineSliceConfig
publicisStale
Returns boolean
setMargins
Sets the 9 slice margins (pixels), and recalculates the 9 slice if desired (auto)
Parameters
left: number
top: number
right: number
bottom: number
auto: boolean = false
Returns void
setStretch
Sets the stretching strategy for the 9 slice, and recalculates the 9 slice if desired (auto)
Parameters
type: horizontal | vertical | both
stretch: NineSliceStretch
auto: boolean = false
Returns void
setTargetHeight
Sets the target height of the 9 slice (pixels), and recalculates the 9 slice if desired (auto)
Parameters
newHeight: number
auto: boolean = false
Returns void
setTargetWidth
Sets the target width of the 9 slice (pixels), and recalculates the 9 slice if desired (auto)
Parameters
newWidth: number
auto: boolean = false
Returns void
A Graphic is the base Excalibur primitive for something that can be drawn to the ExcaliburGraphicsContext. Sprite, Animation, GraphicsGroup, Canvas, Rectangle, Circle, and Polygon all derive from the Graphic abstract class.
Implementors of a Graphic must override the abstract Graphic._drawImage method to render an image to the graphics context. Graphic handles all the position, rotation, and scale transformations in Graphic._preDraw and Graphic._postDraw