Class: Pdfrb::Model::Type::Viewport

Inherits:
Cos::Dictionary show all
Defined in:
lib/pdfrb/model/type/viewport.rb

Overview

Viewport (ISO 32000-2 §12.7.11, PDF 1.6+). Defines a rectangular region of a page intended for separate display, used for magnifier rectangles, measurement regions, and zoom targets.

Instance Attribute Summary

Attributes inherited from Object

#document, #gen, #oid, #value

Instance Method Summary collapse

Methods inherited from Cos::Dictionary

#[], #[]=, arlington_available?, arlington_default, arlington_key_to_symbol, arlington_loaded_for?, arlington_mark_loaded, arlington_object, arlington_one_type_to_ruby, arlington_required?, arlington_types_to_ruby, arlington_version, define_field, define_field_from_arlington, #delete, #each, each_field, #each_raw, #empty?, field, #initialize, #key?, #keys, lookup_type, own_fields, #pdf_type, register_type, type_map, #validate

Methods inherited from Object

#==, define_type, #deref, #indirect?, #initialize, #must_be_indirect?, #pdf_type, pdf_type

Constructor Details

This class inherits a constructor from Pdfrb::Model::Cos::Dictionary

Instance Method Details

#bbox ⇒ Object

/BBox — required, the viewport rectangle.



19
20
21
 
# File 'lib/pdfrb/model/type/viewport.rb', line 19

def bbox
  value[:BBox]
end

#measure(document = nil) ⇒ Object

/Measure — optional indirect Measure dict (RL for rulers, GEO for geospatial since PDF 2.0).



30
31
32
33
34
35
 
# File 'lib/pdfrb/model/type/viewport.rb', line 30

def measure(document = nil)
  ref = value[:Measure]
  return nil unless ref && document

  ref.is_a?(Pdfrb::Model::Reference) ? document.object(ref) : ref
end

#name ⇒ Object

/Name — optional, human-readable viewport name.



24
25
26
 
# File 'lib/pdfrb/model/type/viewport.rb', line 24

def name
  value[:Name]
end

#type ⇒ Object

/Type — optional, fixed "Viewport".



14
15
16
 
# File 'lib/pdfrb/model/type/viewport.rb', line 14

def type
  value[:Type]&.to_sym
end