Class: TopRow

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:23

An object containing information about what elements are in the top row of a block as well as sizing information for the top row. Elements in a top row can consist of corners, hats, spacers, and previous connections. After this constructor is called, the row will contain all non-spacer elements it needs.

Extends

• Row

Extended by

• TopRow

Properties index

Property	Description
type	-
elements	An array of elements contained in this row.
height	The height of the row.
width	The width of the row, from the left edge of the block to the right. Does not include child blocks unless they are inline.
minHeight	The minimum height of the row.
minWidth	The minimum width of the row, from the left edge of the block to the right. Does not include child blocks unless they are inline.
widthWithConnectedBlocks	The width of the row, from the left edge of the block to the edge of the block or any connected child blocks.
yPos	The Y position of the row relative to the origin of the block's svg group.
xPos	The X position of the row relative to the origin of the block's svg group.
hasExternalInput	Whether the row has any external inputs.
hasStatement	Whether the row has any statement inputs.
statementEdge	Where the left edge of all of the statement inputs on the block should be. This makes sure that statement inputs which are proceded by fields of varius widths are all aligned.
hasInlineInput	Whether the row has any inline inputs.
hasDummyInput	Whether the row has any dummy inputs or end-row inputs.
hasJaggedEdge	Whether the row has a jagged edge.
notchOffset	-
align	Alignment of the row.
constants_	-
capline	The starting point for drawing the row, in the y direction. This allows us to draw hats and similar shapes that don't start at the origin. Must be non-negative (see #2820).
ascenderHeight	How much the row extends up above its capline.
hasPreviousConnection	Whether the block has a previous connection.
connection	The previous connection on the block, if any.

Methods index

Method	Description
getLastInput	Get the last input on this row, if it has one.
getFirstSpacer	Convenience method to get the first spacer element on this row.
getLastSpacer	Convenience method to get the last spacer element on this row.
hasLeftSquareCorner	Returns whether or not the top row has a left square corner.
hasRightSquareCorner	Returns whether or not the top row has a right square corner.
measure	Inspect all subcomponents and populate all size properties on the row.
startsWithElemSpacer	Determines whether this row should start with an element spacer.
endsWithElemSpacer	Determines whether this row should end with an element spacer.

Constructors

Constructor

new TopRow(constants): TopRow;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:43

Parameters

Parameter	Type	Description
constants	ConstantProvider	The rendering constants provider.

Returns

TopRow

Overrides

Row.constructor

Properties

type

type: number;

Defined in: packages/blockly/core/renderers/measurables/row.ts:20

Inherited from

Row.type

---

elements

elements: Measurable[] = [];

Defined in: packages/blockly/core/renderers/measurables/row.ts:25

An array of elements contained in this row.

Inherited from

Row.elements

---

height

height: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:30

The height of the row.

Inherited from

Row.height

---

width

width: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:36

The width of the row, from the left edge of the block to the right. Does not include child blocks unless they are inline.

Inherited from

Row.width

---

minHeight

minHeight: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:41

The minimum height of the row.

Inherited from

Row.minHeight

---

minWidth

minWidth: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:47

The minimum width of the row, from the left edge of the block to the right. Does not include child blocks unless they are inline.

Inherited from

Row.minWidth

---

widthWithConnectedBlocks

widthWithConnectedBlocks: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:53

The width of the row, from the left edge of the block to the edge of the block or any connected child blocks.

Inherited from

Row.widthWithConnectedBlocks

---

yPos

yPos: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:59

The Y position of the row relative to the origin of the block's svg group.

Inherited from

Row.yPos

---

xPos

xPos: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:65

The X position of the row relative to the origin of the block's svg group.

Inherited from

Row.xPos

---

hasExternalInput

hasExternalInput: boolean = false;

Defined in: packages/blockly/core/renderers/measurables/row.ts:70

Whether the row has any external inputs.

Inherited from

Row.hasExternalInput

---

hasStatement

hasStatement: boolean = false;

Defined in: packages/blockly/core/renderers/measurables/row.ts:75

Whether the row has any statement inputs.

Inherited from

Row.hasStatement

---

statementEdge

statementEdge: number = 0;

Defined in: packages/blockly/core/renderers/measurables/row.ts:82

Where the left edge of all of the statement inputs on the block should be. This makes sure that statement inputs which are proceded by fields of varius widths are all aligned.

Inherited from

Row.statementEdge

---

hasInlineInput

hasInlineInput: boolean = false;

Defined in: packages/blockly/core/renderers/measurables/row.ts:87

Whether the row has any inline inputs.

Inherited from

Row.hasInlineInput

---

hasDummyInput

hasDummyInput: boolean = false;

Defined in: packages/blockly/core/renderers/measurables/row.ts:92

Whether the row has any dummy inputs or end-row inputs.

Inherited from

Row.hasDummyInput

---

hasJaggedEdge

hasJaggedEdge: boolean = false;

Defined in: packages/blockly/core/renderers/measurables/row.ts:97

Whether the row has a jagged edge.

Inherited from

Row.hasJaggedEdge

---

notchOffset

notchOffset: number;

Defined in: packages/blockly/core/renderers/measurables/row.ts:98

Inherited from

Row.notchOffset

---

align

align: number | null = null;

Defined in: packages/blockly/core/renderers/measurables/row.ts:103

Alignment of the row.

Inherited from

Row.align

---

constants_

protected readonly constants_: ConstantProvider;

Defined in: packages/blockly/core/renderers/measurables/row.ts:105

Inherited from

Row.constants_

---

capline

capline: number = 0;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:29

The starting point for drawing the row, in the y direction. This allows us to draw hats and similar shapes that don't start at the origin. Must be non-negative (see #2820).

---

ascenderHeight

ascenderHeight: number = 0;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:32

How much the row extends up above its capline.

---

hasPreviousConnection

hasPreviousConnection: boolean = false;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:35

Whether the block has a previous connection.

---

connection

connection: PreviousConnection | null = null;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:38

The previous connection on the block, if any.

Methods

getLastInput()

getLastInput(): InputConnection | null;

Defined in: packages/blockly/core/renderers/measurables/row.ts:125

Get the last input on this row, if it has one.

Returns

InputConnection | null

The last input on the row, or null.

Inherited from

Row.getLastInput

---

getFirstSpacer()

getFirstSpacer(): InRowSpacer | null;

Defined in: packages/blockly/core/renderers/measurables/row.ts:166

Convenience method to get the first spacer element on this row.

Returns

InRowSpacer | null

The first spacer element on this row.

Inherited from

Row.getFirstSpacer

---

getLastSpacer()

getLastSpacer(): InRowSpacer | null;

Defined in: packages/blockly/core/renderers/measurables/row.ts:181

Convenience method to get the last spacer element on this row.

Returns

InRowSpacer | null

The last spacer element on this row.

Inherited from

Row.getLastSpacer

---

hasLeftSquareCorner()

hasLeftSquareCorner(block): boolean;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:55

Returns whether or not the top row has a left square corner.

Parameters

Parameter	Type	Description
block	BlockSvg	The block whose top row this represents.

Returns

boolean

Whether or not the top row has a left square corner.

---

hasRightSquareCorner()

hasRightSquareCorner(_block): boolean;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:75

Returns whether or not the top row has a right square corner.

Parameters

Parameter	Type	Description
_block	BlockSvg	The block whose top row this represents.

Returns

boolean

Whether or not the top row has a right square corner.

---

measure()

measure(): void;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:79

Inspect all subcomponents and populate all size properties on the row.

Returns

void

Overrides

Row.measure

---

startsWithElemSpacer()

startsWithElemSpacer(): boolean;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:101

Determines whether this row should start with an element spacer.

Returns

boolean

Whether the row should start with a spacer.

Overrides

Row.startsWithElemSpacer

---

endsWithElemSpacer()

endsWithElemSpacer(): boolean;

Defined in: packages/blockly/core/renderers/measurables/top_row.ts:105

Determines whether this row should end with an element spacer.

Returns

boolean

Whether the row should end with a spacer.

Overrides

Row.endsWithElemSpacer