Class Workspace

Hierarchy (View Summary)

Workspace
- WorkspaceSvg

Constructors

constructor

new Workspace(): Workspace
Returns Workspace

Properties

blockDB_

blockDB_: Record<string, ScratchBlocks.Block>

horizontalLayout

horizontalLayout: boolean

id

id: string

isClearing

isClearing: boolean

listeners_

listeners_: Function[]

MAX_UNDO

MAX_UNDO: 1024

options

options: WorkspaceOptions

potentialVariableMap_

potentialVariableMap_: null | VariableMap

redoStack_

redoStack_: EventsAbstract[]

rendered

rendered: boolean

RTL

RTL: boolean

tapListeners_

tapListeners_: Function[]

toolboxPosition

toolboxPosition: number

topBlocks_

topBlocks_: ScratchBlocks.Block[]

undoStack_

undoStack_: EventsAbstract[]

variableMap_

variableMap_: VariableMap

Methods

addChangeListener

addChangeListener(listener: Function): void
Parameters
- listener: Function
Returns void
- Defined in types/scratch-blocks.d.ts:153

addTopBlock

addTopBlock(block: ScratchBlocks.Block): void
Parameters
- block: ScratchBlocks.Block
Returns void
- Defined in types/scratch-blocks.d.ts:95

addTopComment

addTopComment(comment: WorkspaceComment): void
Parameters
- comment: WorkspaceComment
Returns void
- Defined in types/scratch-blocks.d.ts:98

allInputsFilled

allInputsFilled(shadowBlocksAreFilled?: boolean): boolean
Parameters
- OptionalshadowBlocksAreFilled: boolean
Returns boolean
- Defined in types/scratch-blocks.d.ts:159

clear

clear(): void
Returns void
- Defined in types/scratch-blocks.d.ts:102

clearUndo

clearUndo(): void
Returns void
- Defined in types/scratch-blocks.d.ts:150

createPotentialVariableMap

createPotentialVariableMap(): void
Returns void
- Defined in types/scratch-blocks.d.ts:86

createVariable

createVariable(
    name: string,
    type?: ScratchBlocks.VariableType,
    id?: string,
    isLocal?: boolean,
    isCloud?: boolean,
): VariableModel
Parameters
- name: string
- Optionaltype: ScratchBlocks.VariableType
- Optionalid: string
- OptionalisLocal: boolean
- OptionalisCloud: boolean
Returns VariableModel
See
- Defined in types/scratch-blocks.d.ts:107

deleteVariableById

deleteVariableById(id: string): void
Parameters
- id: string
Returns void
See
- Defined in types/scratch-blocks.d.ts:115

deleteVariableInternal_

deleteVariableInternal_(
variable: VariableModel,
uses: ScratchBlocks.Block[],
): void
Parameters
- variable: VariableModel
- uses: ScratchBlocks.Block[]
Returns void
See
- Defined in types/scratch-blocks.d.ts:119

dispose

dispose(): void
Returns void
- Defined in types/scratch-blocks.d.ts:94

fireChangeListener

fireChangeListener(event: EventsAbstract): void
Parameters
- event: EventsAbstract
Returns void
- Defined in types/scratch-blocks.d.ts:155

getAllBlocks

getAllBlocks(): ScratchBlocks.Block[]
Returns ScratchBlocks.Block[]
- Defined in types/scratch-blocks.d.ts:101

getAllVariables

getAllVariables(): VariableModel[]
Returns VariableModel[]
See
- Defined in types/scratch-blocks.d.ts:143

getBlockById

getBlockById(id: string): null | ScratchBlocks.Block
Parameters
- id: string
Returns null | ScratchBlocks.Block
- Defined in types/scratch-blocks.d.ts:156

getCommentById

getCommentById(id: string): null | WorkspaceComment
Parameters
- id: string
Returns null | WorkspaceComment
- Defined in types/scratch-blocks.d.ts:157

getFlyout

getFlyout(): null | Flyout
Returns null | Flyout
- Defined in types/scratch-blocks.d.ts:158

getPotentialVariableMap

getPotentialVariableMap(): VariableMap
Returns VariableMap
- Defined in types/scratch-blocks.d.ts:85

getTopBlocks

getTopBlocks(): ScratchBlocks.Block[]
Returns ScratchBlocks.Block[]
- Defined in types/scratch-blocks.d.ts:97

getTopComments

getTopComments(): WorkspaceComment[]
Returns WorkspaceComment[]
- Defined in types/scratch-blocks.d.ts:100

getVariable

getVariable(name: string, type?: ScratchBlocks.VariableType): void
Parameters
- name: string
- Optionaltype: ScratchBlocks.VariableType
Returns void
See
- Defined in types/scratch-blocks.d.ts:127

getVariableById

getVariableById(id: string): VariableModel
Parameters
- id: string
Returns VariableModel
See
- Defined in types/scratch-blocks.d.ts:131

getVariableMap

getVariableMap(): VariableMap
Returns VariableMap
- Defined in types/scratch-blocks.d.ts:83

getVariablesOfType

getVariablesOfType(type: ScratchBlocks.VariableType): VariableModel[]
Parameters
- type: ScratchBlocks.VariableType
Returns VariableModel[]
See
- Defined in types/scratch-blocks.d.ts:135

getVariableTypes

getVariableTypes(): ScratchBlocks.VariableType[]
Returns ScratchBlocks.VariableType[]
See
- Defined in types/scratch-blocks.d.ts:139

getVariableUsesById

getVariableUsesById(id: string): ScratchBlocks.Block[]
Parameters
- id: string
Returns ScratchBlocks.Block[]
See
- Defined in types/scratch-blocks.d.ts:111

getWidth

getWidth(): number
Returns number
- Defined in types/scratch-blocks.d.ts:144

hasRedoStack

hasRedoStack(): boolean
Returns boolean
- Defined in types/scratch-blocks.d.ts:151

hasUndoStack

hasUndoStack(): boolean
Returns boolean
- Defined in types/scratch-blocks.d.ts:152

newBlock

newBlock(opcode: string, id?: string): ScratchBlocks.Block
Parameters
- opcode: string
- Optionalid: string
Returns ScratchBlocks.Block
- Defined in types/scratch-blocks.d.ts:145

refreshToolboxSelection_

refreshToolboxSelection_(): void
Returns void
- Defined in types/scratch-blocks.d.ts:93

removeChangeListener

removeChangeListener(listener: Function): void
Parameters
- listener: Function
Returns void
- Defined in types/scratch-blocks.d.ts:154

removeTopBlock

removeTopBlock(block: ScratchBlocks.Block): void
Parameters
- block: ScratchBlocks.Block
Returns void
- Defined in types/scratch-blocks.d.ts:96

removeTopComment

removeTopComment(comment: WorkspaceComment): void
Parameters
- comment: WorkspaceComment
Returns void
- Defined in types/scratch-blocks.d.ts:99

renameVariableById

renameVariableById(id: string, newName: string): void
Parameters
- id: string
- newName: string
Returns void
- Defined in types/scratch-blocks.d.ts:103

undo

undo(redo: boolean): void
Parameters
- redo: boolean
  true for redo, false for undo
Returns void
- Defined in types/scratch-blocks.d.ts:149

variableIndexOf

variableIndexOf(name: string): -1
Parameters
- name: string
Returns -1
Deprecated
always returns -1
- Defined in types/scratch-blocks.d.ts:123