Class: Mindee::Parsing::V2::Field::FieldLocation

Inherits:
Object
  • Object
show all
Defined in:
lib/mindee/parsing/v2/field/field_location.rb

Overview

Location of a field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(server_response) ⇒ FieldLocation

Returns a new instance of FieldLocation.

Parameters:

  • server_response (Hash) —

    Raw server response hash.



18
19
20
21
 
# File 'lib/mindee/parsing/v2/field/field_location.rb', line 18

def initialize(server_response)
  @polygon = Mindee::Geometry::Polygon.new(server_response['polygon'])
  @page = server_response['page']
end

Instance Attribute Details

#page ⇒ Integer? (readonly)

Returns Page on which the field is located.

Returns:

  • (Integer, nil) —

    Page on which the field is located.



15
16
17
 
# File 'lib/mindee/parsing/v2/field/field_location.rb', line 15

def page
  @page
end

#polygon ⇒ Mindee::Geometry::Polygon? (readonly)

Returns Polygon corresponding to the field location.

Returns:



12
13
14
 
# File 'lib/mindee/parsing/v2/field/field_location.rb', line 12

def polygon
  @polygon
end

Instance Method Details

#to_s ⇒ String

String representation of the polygon (empty string when none).

Returns:

  • (String) 


26
27
28
 
# File 'lib/mindee/parsing/v2/field/field_location.rb', line 26

def to_s
  @polygon ? @polygon.to_s : ''
end