Class protos.google.cloud.vision.v1.Paragraph (2.3.8)

Represents a Paragraph.

Package

@google-cloud/vision!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1.IParagraph);

Constructs a new Paragraph.

Parameter

Name	Description
properties	`IParagraph` Properties to set

Properties

boundingBox

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

Paragraph boundingBox.

Property Value

Type	Description
(google.cloud.vision.v1.IBoundingPoly\|null)

confidence

public confidence: number;

Paragraph confidence.

Property Value

Type	Description
number

property

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

Paragraph property.

Property Value

Type	Description
(google.cloud.vision.v1.TextAnnotation.ITextProperty\|null)

words

public words: google.cloud.vision.v1.IWord[];

Paragraph words.

Property Value

Type	Description
google.cloud.vision.v1.IWord[]

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IParagraph): google.cloud.vision.v1.Paragraph;

Creates a new Paragraph instance using the specified properties.

Parameter

Name	Description
properties	`IParagraph` Properties to set

Returns

Type	Description
google.cloud.vision.v1.Paragraph	Paragraph instance

decode(reader, length)

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

Decodes a Paragraph message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.vision.v1.Paragraph	Paragraph

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.vision.v1.Paragraph	Paragraph

encode(message, writer)

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

Encodes the specified Paragraph message. Does not implicitly messages.

Parameters

Name	Description
message	`IParagraph` Paragraph message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Name	Description
message	`IParagraph` Paragraph message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

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

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

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.vision.v1.Paragraph	Paragraph

toJSON()

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

Converts this Paragraph to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.vision.v1.Paragraph` Paragraph
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies a Paragraph message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not