Class protos.google.cloud.vision.v1p4beta1.Block

Represents a Block.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1p4beta1.IBlock);

Constructs a new Block.

Parameter
NameDescription
properties IBlock

Properties to set

Properties

blockType

public blockType: (google.cloud.vision.v1p4beta1.Block.BlockType|keyof typeof google.cloud.vision.v1p4beta1.Block.BlockType);

Block blockType.

boundingBox

public boundingBox?: (google.cloud.vision.v1p4beta1.IBoundingPoly|null);

Block boundingBox.

confidence

public confidence: number;

Block confidence.

paragraphs

public paragraphs: google.cloud.vision.v1p4beta1.IParagraph[];

Block paragraphs.

property

public property?: (google.cloud.vision.v1p4beta1.TextAnnotation.ITextProperty|null);

Block property.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1p4beta1.IBlock): google.cloud.vision.v1p4beta1.Block;

Creates a new Block instance using the specified properties.

Parameter
NameDescription
properties IBlock

Properties to set

Returns
TypeDescription
google.cloud.vision.v1p4beta1.Block

Block instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vision.v1p4beta1.Block;

Decodes a Block message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.vision.v1p4beta1.Block

Block

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vision.v1p4beta1.Block;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.vision.v1p4beta1.Block

Block

encode(message, writer)

public static encode(message: google.cloud.vision.v1p4beta1.IBlock, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Block message. Does not implicitly messages.

Parameters
NameDescription
message IBlock

Block message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.vision.v1p4beta1.IBlock, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBlock

Block message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.vision.v1p4beta1.Block;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.vision.v1p4beta1.Block

Block

toJSON()

public toJSON(): { [k: string]: any };

Converts this Block to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.vision.v1p4beta1.Block, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.vision.v1p4beta1.Block

Block

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Block message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not