Class Input__Class

constructor

• new Input__Class(
      type: number,
      name: string,
      block: Blockly.Block,
      connection: Blockly.Connection,
  ): Input__Class

  Class for an input with an optional field.

  Parameters

  • type: number

    The type of the input.

  • name: string

    Language-neutral identifier which may used to find this input again.

  • block: Blockly.Block

    The block containing this input.

  • connection: Blockly.Connection

    Optional connection for this input.

  Returns Input__Class

align

connection

fieldRow

name

type

appendField

• appendField(field: string | Blockly.Field, opt_name?: string): Input

  Add a field (or label from string), and all prefix and suffix fields, to the end of the input's field row.

  Parameters

  • field: string | Blockly.Field

    Something to add as a field.

  • Optionalopt_name: string

    Language-neutral identifier which may used to find this field again. Should be unique to the host block.

  Returns Input

  The input being append to (to allow chaining).

dispose

• dispose(): void

  Sever all links to this input.

  Returns void

  Suppress

getShadowDom

• getShadowDom(): Element

  Returns the XML representation of the connection's shadow block.

  Returns Element

  Shadow DOM representation of a block or null.

getSourceBlock

• getSourceBlock(): Blockly.Block

  Get the source block for this input.

  Returns Blockly.Block

  The source block, or null if there is none.

init

• init(): void

  Initialize the fields on this input.

  Returns void

insertFieldAt

• insertFieldAt(
      index: number,
      field: string | Blockly.Field,
      opt_name?: string,
  ): number

  Inserts a field (or label from string), and all prefix and suffix fields, at the location of the input's field row.

  Parameters

  • index: number

    The index at which to insert field.

  • field: string | Blockly.Field

    Something to add as a field.

  • Optionalopt_name: string

    Language-neutral identifier which may used to find this field again. Should be unique to the host block.

  Returns number

  The index following the last inserted field.

isVisible

• isVisible(): boolean

  Gets whether this input is visible or not.

  Returns boolean

  True if visible.

markDirty

• markDirty(): void

  Mark all fields on this input as dirty.

  Returns void

  Package

removeField

• removeField(name: string, opt_quiet?: boolean): boolean

  Remove a field from this input.

  Parameters

  • name: string

    The name of the field.

  • Optionalopt_quiet: boolean

    True to prevent an error if field is not present.

  Returns boolean

  True if operation succeeds, false if field is not present and opt_quiet is true.

  Throws

  if the field is not present and opt_quiet is false.

setAlign

• setAlign(align: number): Input

  Change the alignment of the connection's field(s).

  Parameters

  • align: number

    One of the values of Blockly.constants.ALIGN. In RTL mode directions are reversed, and ALIGN.RIGHT aligns to the left.

  Returns Input

  The input being modified (to allow chaining).

setCheck

• setCheck(check: any): Input

  Change a connection's compatibility.

  Parameters

  • check: any

    Compatible value type or list of value types. Null if all types are compatible.

  Returns Input

  The input being modified (to allow chaining).

setShadowDom

• setShadowDom(shadow: Element): Input

  Changes the connection's shadow block.

  Parameters

  • shadow: Element

    DOM representation of a block or null.

  Returns Input

  The input being modified (to allow chaining).

setVisible

• setVisible(visible: boolean): Blockly.BlockSvg[]

  Sets whether this input is visible or not. Should only be used to collapse/uncollapse a block.

  Parameters

  • visible: boolean

    True if visible.

  Returns Blockly.BlockSvg[]

  List of blocks to render.

  Package