Block

google.cloud.vision.v1p2beta1. Block

Represents a Block.

Constructor

new Block(propertiesopt)

Constructs a new Block.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1p2beta1.IBlock <optional>

Properties to set

Implements:
  • IBlock

Members

BlockType

BlockType enum.

Properties:
Name Type Description
UNKNOWN number

UNKNOWN value

TEXT number

TEXT value

TABLE number

TABLE value

PICTURE number

PICTURE value

RULER number

RULER value

BARCODE number

BARCODE value

blockType

Block blockType.

boundingBox

Block boundingBox.

confidence

Block confidence.

paragraphs

Block paragraphs.

property

Block property.

Methods

(static) create(propertiesopt) → {google.cloud.vision.v1p2beta1.Block}

Creates a new Block instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1p2beta1.IBlock <optional>

Properties to set

Returns:
Type Description
google.cloud.vision.v1p2beta1.Block

Block instance

(static) decode(reader, lengthopt) → {google.cloud.vision.v1p2beta1.Block}

Decodes a Block message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.vision.v1p2beta1.Block

Block

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.vision.v1p2beta1.Block}

Decodes a Block message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.vision.v1p2beta1.Block

Block

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Block message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1p2beta1.IBlock

Block message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Block message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1p2beta1.IBlock

Block message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.vision.v1p2beta1.Block}

Creates a Block message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.vision.v1p2beta1.Block

Block

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Block message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1p2beta1.Block

Block

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Block message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Block to JSON.

Returns:
Type Description
Object.<string, *>

JSON object