Class Workspace

constructor

• new Workspace(): Workspace

• Returns Workspace

blockDB_

horizontalLayout

id

isClearing

listeners_

MAX_UNDO

options

potentialVariableMap_

redoStack_

rendered

RTL

tapListeners_

toolboxPosition

topBlocks_

undoStack_

variableMap_

addChangeListener

• addChangeListener(listener: Function): void

• Parameters

  • listener: Function

  Returns void

addTopBlock

• addTopBlock(block: ScratchBlocks.Block): void

• Parameters

  • block: ScratchBlocks.Block

  Returns void

addTopComment

• addTopComment(comment: WorkspaceComment): void

• Parameters

  • comment: WorkspaceComment

  Returns void

allInputsFilled

• allInputsFilled(shadowBlocksAreFilled?: boolean): boolean

• Parameters

  • OptionalshadowBlocksAreFilled: boolean

  Returns boolean

clear

• clear(): void

• Returns void

clearUndo

• clearUndo(): void

• Returns void

createPotentialVariableMap

• createPotentialVariableMap(): void

• Returns void

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

deleteVariableById

• deleteVariableById(id: string): void

• Parameters

  • id: string

  Returns void

  See

deleteVariableInternal_

• deleteVariableInternal_(
      variable: VariableModel,
      uses: ScratchBlocks.Block[],
  ): void

• Parameters

  • variable: VariableModel
  • uses: ScratchBlocks.Block[]

  Returns void

  See

dispose

• dispose(): void

• Returns void

fireChangeListener

• fireChangeListener(event: EventsAbstract): void

• Parameters

  • event: EventsAbstract

  Returns void

getAllBlocks

• getAllBlocks(): ScratchBlocks.Block[]

• Returns ScratchBlocks.Block[]

getAllVariables

• getAllVariables(): VariableModel[]

• Returns VariableModel[]

  See

getBlockById

• getBlockById(id: string): null | ScratchBlocks.Block

• Parameters

  • id: string

  Returns null | ScratchBlocks.Block

getCommentById

• getCommentById(id: string): null | WorkspaceComment

• Parameters

  • id: string

  Returns null | WorkspaceComment

getFlyout

• getFlyout(): null | Flyout

• Returns null | Flyout

getPotentialVariableMap

• getPotentialVariableMap(): VariableMap

• Returns VariableMap

getTopBlocks

• getTopBlocks(): ScratchBlocks.Block[]

• Returns ScratchBlocks.Block[]

getTopComments

• getTopComments(): WorkspaceComment[]

• Returns WorkspaceComment[]

getVariable

• getVariable(name: string, type?: ScratchBlocks.VariableType): void

• Parameters

  • name: string
  • Optionaltype: ScratchBlocks.VariableType

  Returns void

  See

getVariableById

• getVariableById(id: string): VariableModel

• Parameters

  • id: string

  Returns VariableModel

  See

getVariableMap

• getVariableMap(): VariableMap

• Returns VariableMap

getVariablesOfType

• getVariablesOfType(type: ScratchBlocks.VariableType): VariableModel[]

• Parameters

  • type: ScratchBlocks.VariableType

  Returns VariableModel[]

  See

getVariableTypes

• getVariableTypes(): ScratchBlocks.VariableType[]

• Returns ScratchBlocks.VariableType[]

  See

getVariableUsesById

• getVariableUsesById(id: string): ScratchBlocks.Block[]

• Parameters

  • id: string

  Returns ScratchBlocks.Block[]

  See

getWidth

• getWidth(): number

• Returns number

hasRedoStack

• hasRedoStack(): boolean

• Returns boolean

hasUndoStack

• hasUndoStack(): boolean

• Returns boolean

newBlock

• newBlock(opcode: string, id?: string): ScratchBlocks.Block

• Parameters

  • opcode: string
  • Optionalid: string

  Returns ScratchBlocks.Block

refreshToolboxSelection_

• refreshToolboxSelection_(): void

• Returns void

removeChangeListener

• removeChangeListener(listener: Function): void

• Parameters

  • listener: Function

  Returns void

removeTopBlock

• removeTopBlock(block: ScratchBlocks.Block): void

• Parameters

  • block: ScratchBlocks.Block

  Returns void

removeTopComment

• removeTopComment(comment: WorkspaceComment): void

• Parameters

  • comment: WorkspaceComment

  Returns void

renameVariableById

• renameVariableById(id: string, newName: string): void

• Parameters

  • id: string
  • newName: string

  Returns void

undo

• undo(redo: boolean): void

• Parameters

  • redo: boolean

    true for redo, false for undo

  Returns void

variableIndexOf

• variableIndexOf(name: string): -1

• Parameters

  • name: string

  Returns -1

  Deprecated

  always returns -1