Class VariableMap

workspace

clear

• clear(): void

  Clear the variable map.

  Returns void

createVariable

• createVariable(
      name: string,
      opt_type?: string,
      opt_id?: string,
  ): Blockly.VariableModel

  Create a variable with a given name, optional type, and optional ID.

  Parameters

  • name: string

    The name of the variable. This must be unique across variables and procedures.

  • Optionalopt_type: string

    The type of the variable like 'int' or 'string'. Does not need to be unique. Field_variable can filter variables based on their type. This will default to '' which is a specific type.

  • Optionalopt_id: string

    The unique ID of the variable. This will default to a UUID.

  Returns Blockly.VariableModel

  The newly created variable.

deleteVariable

• deleteVariable(variable: Blockly.VariableModel): void

  Delete a variable.

  Parameters

  • variable: Blockly.VariableModel

    Variable to delete.

  Returns void

deleteVariableById

• deleteVariableById(id: string): void

  Delete a variables by the passed in ID and all of its uses from this workspace. May prompt the user for confirmation.

  Parameters

  • id: string

    ID of variable to delete.

  Returns void

deleteVariableInternal

• deleteVariableInternal(
      variable: Blockly.VariableModel,
      uses: Blockly.Block[],
  ): void

  Deletes a variable and all of its uses from this workspace without asking the user for confirmation.

  Parameters

  • variable: Blockly.VariableModel

    Variable to delete.

  • uses: Blockly.Block[]

    An array of uses of the variable.

  Returns void

  Package

getAllVariableNames

• getAllVariableNames(): string[]

  Returns all of the variable names of all types.

  Returns string[]

  All of the variable names of all types.

getAllVariables

• getAllVariables(): Blockly.VariableModel[]

  Return all variables of all types.

  Returns Blockly.VariableModel[]

  List of variable models.

getVariable

• getVariable(name: string, opt_type?: string): Blockly.VariableModel

  Find the variable by the given name and type and return it. Return null if it is not found.

  Parameters

  • name: string

    The name to check for.

  • Optionalopt_type: string

    The type of the variable. If not provided it defaults to the empty string, which is a specific type.

  Returns Blockly.VariableModel

  The variable with the given name, or null if it was not found.

getVariableById

• getVariableById(id: string): Blockly.VariableModel

  Find the variable by the given ID and return it. Return null if not found.

  Parameters

  • id: string

    The ID to check for.

  Returns Blockly.VariableModel

  The variable with the given ID.

getVariablesOfType

• getVariablesOfType(type: string): Blockly.VariableModel[]

  Get a list containing all of the variables of a specified type. If type is null, return list of variables with empty string type.

  Parameters

  • type: string

    Type of the variables to find.

  Returns Blockly.VariableModel[]

  The sought after variables of the passed in type. An empty array if none are found.

getVariableTypes

• getVariableTypes(ws: Blockly.Workspace): string[]

  Return all variable and potential variable types. This list always contains the empty string.

  Parameters

  • ws: Blockly.Workspace

    The workspace used to look for potential variables. This can be different than the workspace stored on this object if the passed in ws is a flyout workspace.

  Returns string[]

  List of variable types.

  Package

getVariableUsesById

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

  Find all the uses of a named variable.

  Parameters

  • id: string

    ID of the variable to find.

  Returns Blockly.Block[]

  Array of block usages.

renameVariable

• renameVariable(variable: Blockly.VariableModel, newName: string): void

  Rename the given variable by updating its name in the variable map.

  Parameters

  • variable: Blockly.VariableModel

    Variable to rename.

  • newName: string

    New variable name.

  Returns void

  Package

renameVariableById

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

  Rename a variable by updating its name in the variable map. Identify the variable to rename with the given ID.

  Parameters

  • id: string

    ID of the variable to rename.

  • newName: string

    New variable name.

  Returns void