Class: SpacerRow
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:17
An object containing information about a spacer between two rows.
Extends
Properties index
| Property | Description |
|---|---|
| type | - |
| 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. |
| 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_ | - |
| followsStatement | - |
| precedesStatement | - |
| widthWithConnectedBlocks | The width of the row, from the left edge of the block to the edge of the block or any connected child blocks. |
| elements | An array of elements contained in this row. |
| height | The height of the spacer. |
| width | The width of the spacer. |
Methods index
| Method | Description |
|---|---|
| getLastInput | Get the last input on this row, if it has one. |
| startsWithElemSpacer | Determines whether this row should start with an element spacer. |
| endsWithElemSpacer | Determines whether this row should end with an element spacer. |
| getFirstSpacer | Convenience method to get the first spacer element on this row. |
| getLastSpacer | Convenience method to get the last spacer element on this row. |
| measure | Inspect all subcomponents and populate all size properties on the row. |
Constructors
Constructor
new SpacerRow(
constants,
height,
width
): SpacerRow;
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:30
Parameters
| Parameter | Type | Description |
|---|---|---|
constants | ConstantProvider | The rendering constants provider. |
height | number | The height of the spacer. |
width | number | The width of the spacer. |
Returns
SpacerRow
Overrides
Properties
type
type: number;
Defined in: packages/blockly/core/renderers/measurables/row.ts:20
Inherited from
minHeight
minHeight: number = 0;
Defined in: packages/blockly/core/renderers/measurables/row.ts:41
The minimum height of the row.
Inherited from
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
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
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
hasExternalInput
hasExternalInput: boolean = false;
Defined in: packages/blockly/core/renderers/measurables/row.ts:70
Whether the row has any external inputs.
Inherited from
hasStatement
hasStatement: boolean = false;
Defined in: packages/blockly/core/renderers/measurables/row.ts:75
Whether the row has any statement inputs.
Inherited from
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
hasInlineInput
hasInlineInput: boolean = false;
Defined in: packages/blockly/core/renderers/measurables/row.ts:87
Whether the row has any inline inputs.
Inherited from
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
hasJaggedEdge
hasJaggedEdge: boolean = false;
Defined in: packages/blockly/core/renderers/measurables/row.ts:97
Whether the row has a jagged edge.
Inherited from
notchOffset
notchOffset: number;
Defined in: packages/blockly/core/renderers/measurables/row.ts:98
Inherited from
align
align: number | null = null;
Defined in: packages/blockly/core/renderers/measurables/row.ts:103
Alignment of the row.
Inherited from
constants_
protected readonly constants_: ConstantProvider;
Defined in: packages/blockly/core/renderers/measurables/row.ts:105
Inherited from
followsStatement
followsStatement: boolean = false;
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:18
precedesStatement
precedesStatement: boolean = false;
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:20
widthWithConnectedBlocks
widthWithConnectedBlocks: number = 0;
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:22
The width of the row, from the left edge of the block to the edge of the block or any connected child blocks.
Overrides
elements
elements: InRowSpacer[];
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:23
An array of elements contained in this row.
Overrides
height
height: number;
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:32
The height of the spacer.
Inherited from
width
width: number;
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:33
The width of the spacer.
Inherited from
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
startsWithElemSpacer()
startsWithElemSpacer(): boolean;
Defined in: packages/blockly/core/renderers/measurables/row.ts:148
Determines whether this row should start with an element spacer.
Returns
boolean
Whether the row should start with a spacer.
Inherited from
endsWithElemSpacer()
endsWithElemSpacer(): boolean;
Defined in: packages/blockly/core/renderers/measurables/row.ts:157
Determines whether this row should end with an element spacer.
Returns
boolean
Whether the row should end with a spacer.
Inherited from
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
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
measure()
measure(): void;
Defined in: packages/blockly/core/renderers/measurables/spacer_row.ts:41
Inspect all subcomponents and populate all size properties on the row.
Returns
void