wbHyperlink

<p>R6 class for a Workbook Hyperlink</p>
<p>R6 class for a Workbook Hyperlink</p>

Simplifies the creation of 'xlsx' files by
providing a high level interface to writing, styling and editing
worksheets.

Jan Marvin Garbuszus

openxlsx2

Read, Write and Edit 'xlsx' Files

Jordan Mark Barbone

 openxlsx authors

Arseny Kapoulkine

wbHyperlink function

<p><div class="r6-fields"></div></p><dl>
<dt><code>ref</code></dt>
<dd><p>ref</p></dd><p></p><p>
<dt><code>target</code></dt>
<dd><p>target</p></dd></p><p>
<dt><code>location</code></dt>
<dd><p>location</p></dd></p><p>
<dt><code>display</code></dt>
<dd><p>display</p></dd></p><p>
<dt><code>is_external</code></dt>
<dd><p>is_external</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/wbHyperlink%24new()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::wbHyperlink$new()"><code>wbHyperlink$new()</code></a></p></li>
<li><p><a href="/link/wbHyperlink%24to_xml()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::wbHyperlink$to_xml()"><code>wbHyperlink$to_xml()</code></a></p></li>
<li><p><a href="/link/wbHyperlink%24to_target_xml()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::wbHyperlink$to_target_xml()"><code>wbHyperlink$to_target_xml()</code></a></p></li>
<li><p><a href="/link/wbHyperlink%24clone()?package=openxlsx2&version=0.3.1" data-mini-rdoc="openxlsx2::wbHyperlink$clone()"><code>wbHyperlink$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-wbHyperlink-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates a new <code>wbHyperlink</code> object</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>wbHyperlink$new(ref, target, location, display = NULL, is_external = TRUE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>ref</code></dt>
<dd><p>ref</p></dd></dl></div></p><p>
<dt><code>target</code></dt>
<dd><p>target</p></dd></p><p>
<dt><code>location</code></dt>
<dd><p>location</p></dd></p><p>
<dt><code>display</code></dt>
<dd><p>display</p></dd></p><p>
<dt><code>is_external</code></dt>
<dd><p>is_external</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>a <code>wbHyperlink</code> object</p>
</div><p></p><p></p><p><hr>
<a id="method-wbHyperlink-to_xml"></a></p><div class="section" id="method-to-xml-">
<h3>Method <code>to_xml()</code></h3>
<p>Convert to xml</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>wbHyperlink$to_xml(id)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>id</code></dt>
<dd><p>???</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A character vector of xml</p>
</div><p></p><p></p><p><hr>
<a id="method-wbHyperlink-to_target_xml"></a></p><div class="section" id="method-to-target-xml-">
<h3>Method <code>to_target_xml()</code></h3>
<p>Convert to target xml</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>wbHyperlink$to_target_xml(id)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>id</code></dt>
<dd><p>???</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-wbHyperlink-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>wbHyperlink$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

R6 class for a Workbook Hyperlink — wbHyperlink

<p><div class="r6-fields"></p><dl>
<dt><code>ref</code></dt>
<dd><p>ref</p></dd>


<dt><code>target</code></dt>
<dd><p>target</p></dd>


<dt><code>location</code></dt>
<dd><p>location</p></dd>


<dt><code>display</code></dt>
<dd><p>display</p></dd>


<dt><code>is_external</code></dt>
<dd><p>is_external</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-wbHyperlink-new'><code>wbHyperlink$new()</code></a></p></li>
<li><p><a href='#method-wbHyperlink-to_xml'><code>wbHyperlink$to_xml()</code></a></p></li>
<li><p><a href='#method-wbHyperlink-to_target_xml'><code>wbHyperlink$to_target_xml()</code></a></p></li>
<li><p><a href='#method-wbHyperlink-clone'><code>wbHyperlink$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-wbHyperlink-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates a new <code>wbHyperlink</code> object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>wbHyperlink$new(ref, target, location, display = NULL, is_external = TRUE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>ref</code></dt>
<dd><p>ref</p></dd>


<dt><code>target</code></dt>
<dd><p>target</p></dd>


<dt><code>location</code></dt>
<dd><p>location</p></dd>


<dt><code>display</code></dt>
<dd><p>display</p></dd>


<dt><code>is_external</code></dt>
<dd><p>is_external</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>a <code>wbHyperlink</code> object</p>
</div>

</div><p><hr>
<a id="method-wbHyperlink-to_xml"></a></p><div class='section' id='method-to-xml-'>
<h3>Method <code>to_xml()</code></h3>
<p>Convert to xml</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>wbHyperlink$to_xml(id)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>id</code></dt>
<dd><p>???</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A character vector of xml</p>
</div>

</div><p><hr>
<a id="method-wbHyperlink-to_target_xml"></a></p><div class='section' id='method-to-target-xml-'>
<h3>Method <code>to_target_xml()</code></h3>
<p>Convert to target xml</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>wbHyperlink$to_target_xml(id)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>id</code></dt>
<dd><p>???</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-wbHyperlink-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>wbHyperlink$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


wbHyperlink: R6 class for a Workbook Hyperlink

Description

Arguments

Value

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `to_xml()`

Usage

Arguments

Returns

Method `to_target_xml()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Value

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method to_xml()

Usage

Arguments

Returns

Method to_target_xml()

Usage

Arguments

Method clone()

Usage

Arguments

Details

Method `new()`

Method `to_xml()`

Method `to_target_xml()`

Method `clone()`