<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Puppeteer::Viewport
— Documentation by YARD 0.9.24
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Puppeteer::Viewport";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (V)</a> »
<span class='title'><span class='object_link'><a href="../Puppeteer.html" title="Puppeteer (class)">Puppeteer</a></span></span>
»
<span class="title">Viewport</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Puppeteer::Viewport
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Puppeteer::Viewport</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/puppeteer/viewport.rb</dd>
</dl>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#device_scale_factor-instance_method" title="#device_scale_factor (instance method)">#<strong>device_scale_factor</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute device_scale_factor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#height-instance_method" title="#height (instance method)">#<strong>height</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute height.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute width.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#has_touch%3F-instance_method" title="#has_touch? (instance method)">#<strong>has_touch?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(width:, height:, device_scale_factor: 1.0, is_mobile: false, has_touch: false, is_landscape: false) ⇒ Viewport </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Viewport.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#landscape%3F-instance_method" title="#landscape? (instance method)">#<strong>landscape?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#mobile%3F-instance_method" title="#mobile? (instance method)">#<strong>mobile?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(width:, height:, device_scale_factor: 1.0, is_mobile: false, has_touch: false, is_landscape: false) ⇒ <tt><span class='object_link'><a href="" title="Puppeteer::Viewport (class)">Viewport</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Viewport.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>width</span>
<span class='type'>(<tt>int</tt>)</span>
</li>
<li>
<span class='name'>height</span>
<span class='type'>(<tt>int</tt>)</span>
</li>
<li>
<span class='name'>device_scale_factor</span>
<span class='type'>(<tt>double</tt>)</span>
<em class="default">(defaults to: <tt>1.0</tt>)</em>
</li>
<li>
<span class='name'>is_mobile</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
</li>
<li>
<span class='name'>has_touch</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
</li>
<li>
<span class='name'>is_landscape</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13
14
15
16
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/puppeteer/viewport.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
<span class='label'>width:</span><span class='comma'>,</span>
<span class='label'>height:</span><span class='comma'>,</span>
<span class='label'>device_scale_factor:</span> <span class='float'>1.0</span><span class='comma'>,</span>
<span class='label'>is_mobile:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>has_touch:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>is_landscape:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='ivar'>@width</span> <span class='op'>=</span> <span class='id identifier rubyid_width'>width</span>
<span class='ivar'>@height</span> <span class='op'>=</span> <span class='id identifier rubyid_height'>height</span>
<span class='ivar'>@device_scale_factor</span> <span class='op'>=</span> <span class='id identifier rubyid_device_scale_factor'>device_scale_factor</span>
<span class='ivar'>@is_mobile</span> <span class='op'>=</span> <span class='id identifier rubyid_is_mobile'>is_mobile</span>
<span class='ivar'>@has_touch</span> <span class='op'>=</span> <span class='id identifier rubyid_has_touch'>has_touch</span>
<span class='ivar'>@is_landscape</span> <span class='op'>=</span> <span class='id identifier rubyid_is_landscape'>is_landscape</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="device_scale_factor-instance_method">
#<strong>device_scale_factor</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute device_scale_factor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/puppeteer/viewport.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_device_scale_factor'>device_scale_factor</span>
<span class='ivar'>@device_scale_factor</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="height-instance_method">
#<strong>height</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute height.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/puppeteer/viewport.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span>
<span class='ivar'>@height</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="width-instance_method">
#<strong>width</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute width.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/puppeteer/viewport.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
<span class='ivar'>@width</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="has_touch?-instance_method">
#<strong>has_touch?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/puppeteer/viewport.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_has_touch?'>has_touch?</span>
<span class='ivar'>@has_touch</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="landscape?-instance_method">
#<strong>landscape?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/puppeteer/viewport.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_landscape?'>landscape?</span>
<span class='ivar'>@is_landscape</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="mobile?-instance_method">
#<strong>mobile?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/puppeteer/viewport.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mobile?'>mobile?</span>
<span class='ivar'>@is_mobile</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Apr 26 15:52:57 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.6.3).
</div>
</div>
</body>
</html>