API Docs for: 6.0.1
Show:

Frame Class

Extends Base
Module: scrawlFrame

Frame

Instantiation

  • scrawl.makeFrame()

Purpose

  • Defines a Frame entity

Access

  • scrawl.entity.FRAMENAME - for the Frame entity object

Constructor

Frame

(
  • [items]
)

Parameters:

  • [items] Object optional

    Key:value Object argument for setting attributes

Item Index

Methods

checkCorners

(
  • items
)
private chainable

Parameters:

  • items Object

    Object consisting of key:value attributes

Returns:

This

checkHit

(
  • items
)

Check Cell coordinates to see if any of them fall within this entity's path - uses JavaScript's isPointInPath function

Argument object contains the following attributes:

  • tests - an array of Vector coordinates to be checked; alternatively can be a single Vector
  • x - X coordinate
  • y - Y coordinate

Either the 'tests' attribute should contain a Vector, or an array of vectors, or the x and y attributes should be set to Number values

Parameters:

  • items Object

    Argument object

Returns:

The first coordinate to fall within the entity's path; false if none fall within the path

clear

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'clear' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

clearShadow

(
  • ctx
  • cellname
  • cell
)
private chainable

stamp helper function - clear shadow parameters during a multi draw operation (drawFill and fillDraw methods)

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

clearWithBackground

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'clearWithBackground' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

clip

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'clip' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

clone

(
  • items
)
chainable

Inherited from Base but overwritten in source\scrawlFrame.js:1187

Augments Base.clone()

Parameters:

  • items Object

    Object consisting of key:value attributes

Returns:

This

collisionsEntityRegisterInLibrary

() private

Frame.registerInLibrary hook function - modified by collisions extension

draw

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'draw' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

drawFill

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'drawFill' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

drawImage

(
  • ctx
  • cellname
  • cell
)
private

stamp helper function - fill thge entity

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

drawPath

(
  • ctx
  • cellname
  • cell
)
private

stamp helper function - draw the path between the corner points

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

dropEntity

(
  • [items]
)
chainable

Revert pickupEntity() actions, ensuring entity is left where the user drops it

Parameters:

  • [items] String optional

    Alternative pivot String

Returns:

This

fill

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'fill' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

fillDraw

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'fillDraw' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

filtersEntityInit

() private

Entity constructor hook function - modified by filters module

floatOver

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'floatOver' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

forceStamp

(
  • [method]
  • [cellname]
  • [cell]
  • [mouse]
)
chainable

Stamp function - instruct entity to draw itself on a Cell's <canvas> element, regardless of the setting of its visibility attribute

Permitted methods include:

  • 'draw' - stroke the entity's path with the entity's strokeStyle color, pattern or gradient
  • 'fill' - fill the entity's path with the entity's fillStyle color, pattern or gradient
  • 'drawFill' - stroke, and then fill, the entity's path; if a shadow offset is present, the shadow is added only to the stroke action
  • 'fillDraw' - fill, and then stroke, the entity's path; if a shadow offset is present, the shadow is added only to the fill action
  • 'floatOver' - stroke, and then fill, the entity's path; shadow offset is added to both actions
  • 'sinkInto' - fill, and then stroke, the entity's path; shadow offset is added to both actions
  • 'clear' - fill the entity's path with transparent color 'rgba(0, 0, 0, 0)'
  • 'clearWithBackground' - fill the entity's path with the Cell's current backgroundColor
  • 'clip' - clip the drawing zone to the entity's path (not tested)
  • 'none' - perform all necessary updates, but do not draw the entity onto the canvas

Parameters:

  • [method] String optional

    Permitted method attribute String; by default, will use entity's own method setting

  • [cellname] String optional

    CELLNAME of cell on which entitys are to draw themselves

  • [cell] Object optional

    cell wrapper object

  • [mouse] Vector optional

    coordinates to be used for any entity currently pivoted to a mouse/touch event

Returns:

This

get

(
  • item
)

Retrieve an attribute value. If the attribute value has not been set, then the default value for that attribute will be returned.

Parameters:

  • item String

    Attribute key

Returns:

Attribute value

Example:

var box = scrawl.makeBlock({
    width: 50,
    });
box.get('width');               //returns 50
box.get('height');              //returns 0
box.get('favouriteAnimal');     //returns undefined

getAngle

() private

redrawCanvas helper function

getCorners

()

Returns:

Object containing x/y coordinate objects for each corner

Example:

Returns an object with the following structure:

{
    topLeft: {x: 0, y:0},
    topRight: {x: 0, y:0},
    bottomRight: {x: 0, y:0},
    bottomLeft: {x: 0, y:0}
}

getLength

() private

redrawCanvas helper function

getMaxDimensions

(
  • cell
  • entity
)
private

Calculate the box position of the entity

Returns an object with the following attributes:

  • left - x coordinate of top-left corner of the enclosing box relative to the current cell's top-left corner
  • top - y coordinate of top-left corner of the enclosing box relative to the current cell's top-left corner
  • bottom - x coordinate of bottom-right corner of the enclosing box relative to the current cell's top-left corner
  • left - y coordinate of bottom-right corner of the enclosing box relative to the current cell's top-left corner

Parameters:

  • cell Object

    object

  • entity Object

    object

Returns:

dimensions object

getPosition

() private

redrawCanvas helper function

lockOn

(
  • items
)
private

Attach a Frame entity to an existing stack element, or create a new stack <div> element

Parameters:

  • items Object

    Object consisting of key:value attributes

none

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'none' method draw. This involves setting the <canvas> element's context engine's values with this entity's context values, but not defining or drawing the entity on the canvas.

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

numberConvert

(
  • val
  • dim
)
private

Stamp helper function - convert string percentage values to numerical values

Parameters:

  • val String

    coordinate String

  • dim Number

    dimension value

Returns:

Number - value

parse

()

Turn the object into a JSON String

Returns:

object of object's currently set attributes

pickupEntity

(
  • items
)
chainable

Set entity's pivot to 'mouse'; set handles to supplied Vector value; set order to +9999

Parameters:

  • items Vector

    Coordinate vector; alternatively an object with {x, y} attributes can be used

Returns:

This

prepareStamp

(
  • ctx
  • cellname
  • cell
)
private

stamp helper function

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

redrawCanvas

() private

Draw Frame entity in its own local canvas, then copy over to destimation canvas

resetEasel

() private

redrawCanvas helper function

set

(
  • items
)
chainable

Inherited from Base but overwritten in source\scrawlFrame.js:1148

Augments Base.set()

Parameters:

  • items Object

    Object consisting of key:value attributes

Returns:

This

setCorners

(
  • items
)
private chainable

Parameters:

  • items Object

    Object consisting of key:value attributes

Returns:

This

setDestinationEngine

(
  • Object
  • String
  • Object
)
private

Parameters:

  • Object Object

    ctx - 2d context engine

  • String Object
    • CELLNAME
  • Object Object
    • scrawl Cell object

setEasel

() private

redrawCanvas helper function

setEngine

(
  • items
)
private

Parameters:

  • items Object

    Object consisting of key:value attributes

setLockElementAttributes

(
  • items
)
private chainable

Parameters:

  • items Object

    Object consisting of key:value attributes

Returns:

This

sinkInto

(
  • ctx
  • cellname
  • cell
)
private chainable

Stamp helper function - perform a 'sinkInto' method draw

Parameters:

  • ctx Object

    JavaScript context engine for Cell's <canvas> element

  • cellname String

    CELLNAME string of Cell to be drawn on; by default, will use the Cell associated with this entity's Group object

  • cell Object

    scrawl Cell object

Returns:

This

stamp

(
  • [method]
  • [cellname]
  • [cell]
  • [mouse]
)
chainable

Stamp function - instruct entity to draw itself on a Cell's <canvas> element, if its visibility attribute is true

Permitted methods include:

  • 'draw' - stroke the entity's path with the entity's strokeStyle color, pattern or gradient
  • 'fill' - fill the entity's path with the entity's fillStyle color, pattern or gradient
  • 'drawFill' - stroke, and then fill, the entity's path; if a shadow offset is present, the shadow is added only to the stroke action
  • 'fillDraw' - fill, and then stroke, the entity's path; if a shadow offset is present, the shadow is added only to the fill action
  • 'floatOver' - stroke, and then fill, the entity's path; shadow offset is added to both actions
  • 'sinkInto' - fill, and then stroke, the entity's path; shadow offset is added to both actions
  • 'clear' - fill the entity's path with transparent color 'rgba(0, 0, 0, 0)'
  • 'clearWithBackground' - fill the entity's path with the Cell's current backgroundColor
  • 'clip' - clip the drawing zone to the entity's path (not tested)
  • 'none' - perform all necessary updates, but do not draw the entity onto the canvas

Parameters:

  • [method] String optional

    Permitted method attribute String; by default, will use entity's own method setting

  • [cellname] String optional

    CELLNAME of cell on which entitys are to draw themselves

  • [cell] Object optional

    cell wrapper object

  • [mouse] Vector optional

    coordinates to be used for any entity currently pivoted to a mouse/touch event

Returns:

This

stampFilter

() private

Entity.stamp hook function - add a filter to an Entity, and any background detail enclosed by the Entity

stampFilterActions

() private

reciprocal assignment - also occurs in scrawlFilters as there's no way to tell which file (scrawlFrame, scrawlFilters) will be loaded first

stampFilterDefault

() private

Entity.stamp hook helper function

updateCurrentCopy

() private

redrawCanvas helper function - updates copy parameters

Properties

bottomLeft

Object - x:Number, y:Number private

Current coordinate for bottom left corner

Default: false

bottomLeftDeltaPathPlace

Number

Attribute cascaded to appropriate FramePoint object deltaPathPlace attribute

Default: false

bottomLeftLockX

Boolean

Attribute cascaded to appropriate FramePoint object lockX attribute

Default: false

bottomLeftLockY

Boolean

Attribute cascaded to appropriate FramePoint object lockY attribute

Default: false

bottomLeftPath

String

Attribute cascaded to appropriate FramePoint object path attribute

Default: false

bottomLeftPathPlace

Number

Attribute cascaded to appropriate FramePoint object pathPlace attribute

Default: false

bottomLeftPathSpeedConstant

Boolean

Attribute cascaded to appropriate FramePoint object pathSpeedConstant attribute

Default: false

bottomLeftPivot

String

Attribute cascaded to appropriate FramePoint object pivot attribute

Default: false

bottomRight

Object - x:Number, y:Number private

Current coordinate for bottom right corner

Default: false

bottomRightDeltaPathPlace

Number

Attribute cascaded to appropriate FramePoint object deltaPathPlace attribute

Default: false

bottomRightLockX

Boolean

Attribute cascaded to appropriate FramePoint object lockX attribute

Default: false

bottomRightLockY

Boolean

Attribute cascaded to appropriate FramePoint object lockY attribute

Default: false

bottomRightPath

String

Attribute cascaded to appropriate FramePoint object path attribute

Default: false

bottomRightPathPlace

Number

Attribute cascaded to appropriate FramePoint object pathPlace attribute

Default: false

bottomRightPathSpeedConstant

Boolean

Attribute cascaded to appropriate FramePoint object pathSpeedConstant attribute

Default: false

bottomRightPivot

String

Attribute cascaded to appropriate FramePoint object pivot attribute

Default: false

cell

DOM canvas element private

Every Frame entity includes its own personal <canvas> element, which is not part of the DOM and which can only be accessed through this attribute

Default: false

comment

String

Comment, for accessibility

Default: ''

currentFrame

DOM element object private

If present, the DOM <div> element being used to position entity within the stack

Default: false

engine

CanvasRenderingContext2D interface private

The Frame entity's <canvas> element's 2d context engine - not stored in the scrawl library and can only be accessed through this attribute

Default: false

filterLevel

String

The filterLevel attribute determines at which point in the display cycle the filter will be applied. Permitted values are:

  • 'entity' - filter is applied immediately after the Entity has stamped itself onto a cell
  • 'cell' - filter is applied after all Entites have completed stamping themselves onto the cell
  • 'pad' - filter is applied to the base canvas after all cells have completed copying themselves onto it, and before the base cell copies itself onto the display cell

Default: 'entity'

filterOnStroke

Boolean

Filter flag - when true, will draw the entity; on false (default), the clip method is used instead

Default: false

filters

Array

Array of FILTERNAME strings, for filters to be applied to this entity

Default: []

flipReverse

Boolean

Reflection flag; set to true to flip entity, cell or element along the Y axis - this has no meaning to Frame entitys (which can be repositioned either by directly repositioning corners, or by rotating any associated stack element), but has to be included for compatibility with core entity functionality

Default: false

flipUpend

Boolean

Reflection flag; set to true to flip entity, cell or element along the X axis - this has no meaning to Frame entitys (which can be repositioned either by directly repositioning corners, or by rotating any associated stack element), but has to be included for compatibility with core entity functionality

Default: false

globalAlpha

Number private

Entity transparency - a value between 0 and 1, where 0 is completely transparent and 1 is completely opaque

Default: 1

globalCompositeOperation

String

Compositing method for applying the entity to an existing Cell (<canvas>) display. Permitted values include

  • 'source-over'
  • 'source-atop'
  • 'source-in'
  • 'source-out'
  • 'destination-over'
  • 'destination-atop'
  • 'destination-in'
  • 'destination-out'
  • 'lighter'
  • 'darker'
  • 'copy'
  • 'xor'

Be aware that different browsers render these operations in different ways, and some options are not supported by all browsers

Default: 'source-over'

group

String

GROUPNAME String for this entity's default group

Note: an entity can belong to more than one group by being added to other Group objects via the scrawl.addEntitysToGroups() and Group.addEntityToGroup() functions

Default: false

height

Number private

Enclosing height of entity

Default: 1

height

Number

Top left corner reference point for enclosing dimension box of entity

Default: 1

interferenceFactor

Number

The current Frame drawing process often leads to moire interference patterns appearing in the resulting image. Scrawl uses resizing to blur out these patterns. The interferenceFactor attribute sets the resizing ratio; if patterns still appear in the final image, change this value to something more appropriate

Default: 1.03

interferenceLoops

Number

The current Frame drawing process often leads to moire interference patterns appearing in the resulting image. Scrawl uses resizing to blur out these patterns. The interferenceLoops attribute sets the number of times the image gets resized; if patterns still appear in the final image, increase this value

Default: 2

lineCap

String

Outline cap styling. Permitted values include:

  • 'butt'
  • 'round'
  • 'square'

Default: 'butt'

lineDash

Array

Outline dash format - an array of Numbers representing line and gap values (in pixels), for example [5,2,2,2] for a long-short dash pattern

Default: []

lineDashOffset

Number

Outline dash offset - distance along the entity's outline at which to start the line dash. Changing this value can be used to create a 'marching ants effect

Default: 0

lineJoin

String

Outline join styling. Permitted values include:

  • 'miter'
  • 'round'
  • 'bevel'

Default: 'miter'

lineWidth

Number

Outline width, in pixels

Default: 0

localHeight

Number private

Used as part of core entity collision detection functionality - must always be the same as height attribute

Default: 1

localWidth

Number private

Used as part of core entity collision detection functionality - must always be the same as width attribute

Default: 1

lockElementAttributes

Object private

JavaScript Object containing key:value pairs - used to cascade data to underlying stack element (if present)

Default: false

lockElementAttributesList

Array private

Array of key Strings used to whitelist the permitted attributes for cascade to stack element, if present. Used by lockElementAttributes attribute

Default: ['start', 'startX', 'startY', 'handle', 'handleX', 'handleY', 'deltaStart', 'deltaStartX', 'deltaStartY', 'deltaHandle', 'deltaHandleX', 'deltaHandleY', 'width', 'height', 'scale', 'deltaScale', 'deltaRoll', 'deltaPitch', 'deltaYaw', 'roll', 'pitch', 'yaw', 'includeCornerTrackers', 'pivot', 'path', 'pathPlace', 'deltaPathPlace', 'pathSpeedConstant', 'translate', 'translateX', 'translateY', 'translateZ', 'mouseIndex', 'cursor']

lockFrameTo

String

ELEMENTNAME of stack element which frame entity will use for positioning data

Default: false

lockX

Boolean

Positioning flag; set to true to ignore path/pivot/mouse changes along the X axis - will only affect any underlying stack div element used for positioning the frame entity. Note that each corner can also be individually restricted

Default: false

lockY

Boolean

Positioning flag; set to true to ignore path/pivot/mouse changes along the Y axis - will only affect any underlying stack div element used for positioning the frame entity. Note that each corner can also be individually restricted

Default: false

maxDimensions

Object private

Maximum dimensions - used as part of entity filter and collision detection functionality

Default: {top:0, bottom:0, left:0, right:0, flag:true}

method

String

Entity drawing method. A entity can be drawn onto a <canvas> element in a variety of ways; these methods include:

  • 'draw' - stroke the entity's path with the entity's strokeStyle color, pattern or gradient
  • 'fill' - fill the entity's path with the entity's fillStyle color, pattern or gradient
  • 'drawFill' - stroke, and then fill, the entity's path; if a shadow offset is present, the shadow is added only to the stroke action
  • 'fillDraw' - fill, and then stroke, the entity's path; if a shadow offset is present, the shadow is added only to the fill action
  • 'floatOver' - stroke, and then fill, the entity's path; shadow offset is added to both actions
  • 'sinkInto' - fill, and then stroke, the entity's path; shadow offset is added to both actions
  • 'clear' - fill the entity's path with transparent color 'rgba(0, 0, 0, 0)'
  • 'clearWithBackground' - fill the entity's path with the Cell's current backgroundColor
  • 'clip' - clip the drawing zone to the entity's path (not tested)
  • 'none' - perform all necessary updates, but do not draw the entity onto the canvas

Note: not all entitys support all of these operations

Default: 'fill'

miterLimit

Number

miterLimit - affecting the 'pointiness' of the outline join where two lines join at an acute angle

Default: 10

mouseIndex

String

Index of mouse vector to use when pivot === 'mouse'

The Pad.mice object can hold details of multiple touch events - when an entity is assigned to a 'mouse', it needs to know which of those mouse trackers to use. Default: mouse (for the mouse cursor vector)

Default: 'mouse'

name

String

Unique identifier for each object; default: computer-generated String based on Object's type

order

Number

Entity order value - lower order entitys are drawn on <canvas> elements before higher order entitys

Default: 0

path

String

The ENTITYNAME of a Path entity to be used for setting this entity's start point - will only affect any underlying stack div element used for positioning the frame entity.

Note that each corner can also have its own path reference

Default: null

pivot

String

The ENTITYNAME or POINTNAME of a entity or Point object to be used for setting this object's start point - will only affect any underlying stack div element used for positioning the frame entity.

Note that each corner can also have its own pivot reference

Default: null

redraw

Boolean private

Dirty flag - sets to true when certain entity attributes change

Default: false

shadowBlur

Number

Blur border for a entity's shadow, in pixels

Default: 0

shadowColor

String

Color used for entity shadow effect. Can be:

  • Cascading Style Sheet format color String - '#fff', '#ffffff', 'rgb(255,255,255)', 'rgba(255,255,255,1)', 'white'
  • COLORNAME String

Default: '#000000'

shadowOffsetX

Number

Horizontal offset of a entity's shadow, in pixels

Default: 0

shadowOffsetY

Number

Vertical offset of a entity's shadow, in pixels

Default: 0

source

String

ASSETNAME or CANVASNAME of source asset used to fill frame

Default: false

strokeStyle

String

Color, gradient or pattern used to outline a entity. Can be:

  • Cascading Style Sheet format color String - '#fff', '#ffffff', 'rgb(255,255,255)', 'rgba(255,255,255,1)', 'white'
  • COLORNAME String
  • GRADIENTNAME String
  • RADIALGRADIENTNAME String
  • PATTERNNAME String

Default: '#000000'

timestamp

String

Creation timestamp

Default: ''

title

String

Title, for accessibility

Default: ''

topLeft

Object - x:Number, y:Number private

Current coordinate for top left corner

Default: false

topLeftDeltaPathPlace

Number

Attribute cascaded to appropriate FramePoint object deltaPathPlace attribute

Default: false

topLeftLockX

Boolean

Attribute cascaded to appropriate FramePoint object lockX attribute

Default: false

topLeftLockY

Boolean

Attribute cascaded to appropriate FramePoint object lockY attribute

Default: false

topLeftPath

String

Attribute cascaded to appropriate FramePoint object path attribute

Default: false

topLeftPathPlace

Number

Attribute cascaded to appropriate FramePoint object pathPlace attribute

Default: false

topLeftPathSpeedConstant

Boolean

Attribute cascaded to appropriate FramePoint object pathSpeedConstant attribute

Default: false

topLeftPivot

String

Attribute cascaded to appropriate FramePoint object pivot attribute

Default: false

topRight

Object - x:Number, y:Number private

Current coordinate for top right corner

Default: false

topRightDeltaPathPlace

Number

Attribute cascaded to appropriate FramePoint object deltaPathPlace attribute

Default: false

topRightLockX

Boolean

Attribute cascaded to appropriate FramePoint object lockX attribute

Default: false

topRightLockY

Boolean

Attribute cascaded to appropriate FramePoint object lockY attribute

Default: false

topRightPath

String

Attribute cascaded to appropriate FramePoint object path attribute

Default: false

topRightPathPlace

Number

Attribute cascaded to appropriate FramePoint object pathPlace attribute

Default: false

topRightPathSpeedConstant

Boolean

Attribute cascaded to appropriate FramePoint object pathSpeedConstant attribute

Default: false

topRightPivot

String

Attribute cascaded to appropriate FramePoint object pivot attribute

Default: false

type

String final

Inherited from Base but overwritten in source\scrawlFrame.js:556

Default: 'Frame'

visibility

Boolean

Visibility flag - entitys will (in general) not be drawn on a <canvas> element when this flag is set to false

Default: true

width

Number private

Enclosing width of entity

Default: 1