@tobyt/expo-pdf-markup 1.1.1 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/README.md +9 -6
- package/build/ExpoPdfMarkup.types.d.ts.map +1 -1
- package/build/ExpoPdfMarkup.types.js.map +1 -1
- package/build/ExpoPdfMarkupView.d.ts +1 -1
- package/build/ExpoPdfMarkupView.d.ts.map +1 -1
- package/build/ExpoPdfMarkupView.js +2 -1
- package/build/ExpoPdfMarkupView.js.map +1 -1
- package/build/ExpoPdfMarkupView.web.d.ts +2 -0
- package/build/ExpoPdfMarkupView.web.d.ts.map +1 -1
- package/build/ExpoPdfMarkupView.web.js +39 -36
- package/build/ExpoPdfMarkupView.web.js.map +1 -1
- package/build/index.d.ts +1 -1
- package/build/index.d.ts.map +1 -1
- package/build/index.js +1 -1
- package/build/index.js.map +1 -1
- package/build/pdfjs.d.ts +1 -0
- package/build/pdfjs.d.ts.map +1 -1
- package/build/pdfjs.js +3 -0
- package/build/pdfjs.js.map +1 -1
- package/build/pdfjs.web.d.ts +1 -1
- package/build/pdfjs.web.d.ts.map +1 -1
- package/build/pdfjs.web.js +1 -1
- package/build/pdfjs.web.js.map +1 -1
- package/build/web/annotationUtils.d.ts.map +1 -1
- package/build/web/annotationUtils.js +13 -5
- package/build/web/annotationUtils.js.map +1 -1
- package/docs/.nojekyll +1 -0
- package/docs/assets/hierarchy.js +1 -0
- package/docs/assets/highlight.css +113 -0
- package/docs/assets/icons.js +18 -0
- package/docs/assets/icons.svg +1 -0
- package/docs/assets/main.js +60 -0
- package/docs/assets/navigation.js +1 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1648 -0
- package/docs/functions/ExpoPdfMarkupView.html +42 -0
- package/docs/functions/setPdfJsWorkerSrc.html +42 -0
- package/docs/hierarchy.html +29 -0
- package/docs/index.html +148 -0
- package/docs/modules.html +40 -0
- package/docs/types/Annotation.html +33 -0
- package/docs/types/AnnotationBounds.html +73 -0
- package/docs/types/AnnotationMode.html +33 -0
- package/docs/types/AnnotationPoint.html +61 -0
- package/docs/types/AnnotationsData.html +61 -0
- package/docs/types/ExpoPdfMarkupViewProps.html +184 -0
- package/docs/types/HighlightAnnotation.html +91 -0
- package/docs/types/InkAnnotation.html +91 -0
- package/docs/types/StampAnnotation.html +95 -0
- package/docs/types/StampDefinition.html +72 -0
- package/docs/types/TextAnnotation.html +110 -0
- package/docs/types/TextInputRequest.html +73 -0
- package/docs/types/UnderlineAnnotation.html +85 -0
- package/ios/AnnotationSerializer.swift +6 -34
- package/ios/ExpoPdfMarkupView+Ink.swift +2 -10
- package/ios/ExpoPdfMarkupView+Move.swift +4 -3
- package/ios/ExpoPdfMarkupView.swift +4 -3
- package/ios/InkPDFAnnotation.swift +45 -0
- package/ios/Tests/AnnotationSerializerTests.swift +26 -0
- package/metro.js +47 -20
- package/package.json +8 -8
- package/src/ExpoPdfMarkup.types.ts +2 -13
- package/src/ExpoPdfMarkupView.tsx +1 -1
- package/src/ExpoPdfMarkupView.web.tsx +26 -13
- package/src/index.ts +1 -1
- package/src/pdfjs.ts +4 -0
- package/src/pdfjs.web.ts +1 -1
- package/src/web/annotationUtils.ts +11 -5
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ExpoPdfMarkupViewProps | @tobyt/expo-pdf-markup - v1.1.1</title><meta name="description" content="Documentation for @tobyt/expo-pdf-markup"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@tobyt/expo-pdf-markup - v1.1.1</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">ExpoPdfMarkupViewProps</a></li></ul>
|
|
12
|
+
<h1>Type Alias ExpoPdfMarkupViewProps</h1></div>
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">ExpoPdfMarkupViewProps</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#annotationcolor">annotationColor</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#annotationfontfamily">annotationFontFamily</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#annotationlinewidth">annotationLineWidth</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#annotationmode">annotationMode</a><span class="tsd-signature-symbol">?:</span> <a href="AnnotationMode.html" class="tsd-signature-type tsd-kind-type-alias">AnnotationMode</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#annotations">annotations</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#backgroundcolor">backgroundColor</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onannotationschanged">onAnnotationsChanged</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">annotations</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onerror">onError</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onloadcomplete">onLoadComplete</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">pageCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onpagechanged">onPageChanged</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">pageCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">pageHeight</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">pageWidth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#ontextinputrequested">onTextInputRequested</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="TextInputRequest.html" class="tsd-signature-type tsd-kind-type-alias">TextInputRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#page">page</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#source">source</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stampsize">stampSize</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stamptext">stampText</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#style">style</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StyleProp</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ViewStyle</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
14
|
+
<ul>
|
|
15
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L95">ExpoPdfMarkup.types.ts:95</a></li></ul></aside>
|
|
16
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
17
|
+
<section class="tsd-panel tsd-index-panel">
|
|
18
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
19
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
20
|
+
<div class="tsd-accordion-details">
|
|
21
|
+
<section class="tsd-index-section">
|
|
22
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
23
|
+
<div class="tsd-index-list"><a href="#annotationcolor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Color?</span></a>
|
|
24
|
+
<a href="#annotationfontfamily" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Font<wbr/>Family?</span></a>
|
|
25
|
+
<a href="#annotationlinewidth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Line<wbr/>Width?</span></a>
|
|
26
|
+
<a href="#annotationmode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Mode?</span></a>
|
|
27
|
+
<a href="#annotations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotations?</span></a>
|
|
28
|
+
<a href="#backgroundcolor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>background<wbr/>Color?</span></a>
|
|
29
|
+
<a href="#onannotationschanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Annotations<wbr/>Changed?</span></a>
|
|
30
|
+
<a href="#onerror" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Error?</span></a>
|
|
31
|
+
<a href="#onloadcomplete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Load<wbr/>Complete?</span></a>
|
|
32
|
+
<a href="#onpagechanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Page<wbr/>Changed?</span></a>
|
|
33
|
+
<a href="#ontextinputrequested" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Text<wbr/>Input<wbr/>Requested?</span></a>
|
|
34
|
+
<a href="#page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page?</span></a>
|
|
35
|
+
<a href="#source" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>source</span></a>
|
|
36
|
+
<a href="#stampsize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stamp<wbr/>Size?</span></a>
|
|
37
|
+
<a href="#stamptext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stamp<wbr/>Text?</span></a>
|
|
38
|
+
<a href="#style" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style?</span></a>
|
|
39
|
+
</div></section></div></details></section></section>
|
|
40
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
41
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
42
|
+
<section>
|
|
43
|
+
<section class="tsd-panel tsd-member">
|
|
44
|
+
<h3 class="tsd-anchor-link" id="annotationcolor"><code class="tsd-tag">Optional</code><span>annotation<wbr/>Color</span><a href="#annotationcolor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
45
|
+
<div class="tsd-signature"><span class="tsd-kind-property">annotationColor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
46
|
+
<div class="tsd-comment tsd-typography"><p>Colour applied to new annotations, as a CSS colour string (e.g. <code>'#FF0000'</code>).</p>
|
|
47
|
+
</div><aside class="tsd-sources">
|
|
48
|
+
<ul>
|
|
49
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L107">ExpoPdfMarkup.types.ts:107</a></li></ul></aside></section>
|
|
50
|
+
<section class="tsd-panel tsd-member">
|
|
51
|
+
<h3 class="tsd-anchor-link" id="annotationfontfamily"><code class="tsd-tag">Optional</code><span>annotation<wbr/>Font<wbr/>Family</span><a href="#annotationfontfamily" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
52
|
+
<div class="tsd-signature"><span class="tsd-kind-property">annotationFontFamily</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
53
|
+
<div class="tsd-comment tsd-typography"><p>Default font family for new text annotations. Platform-specific:</p>
|
|
54
|
+
<ul>
|
|
55
|
+
<li>iOS: PostScript name (<code>"Georgia"</code>, <code>"Courier"</code>) or <code>undefined</code> for system font (San Francisco)</li>
|
|
56
|
+
<li>Android: React Native / Expo font family name (<code>"Montserrat-Regular"</code>, <code>"serif"</code>) or <code>undefined</code> for default sans-serif</li>
|
|
57
|
+
<li>Web: CSS font family (<code>"Georgia, serif"</code>) or <code>undefined</code> for <code>sans-serif</code></li>
|
|
58
|
+
</ul>
|
|
59
|
+
</div><aside class="tsd-sources">
|
|
60
|
+
<ul>
|
|
61
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L116">ExpoPdfMarkup.types.ts:116</a></li></ul></aside></section>
|
|
62
|
+
<section class="tsd-panel tsd-member">
|
|
63
|
+
<h3 class="tsd-anchor-link" id="annotationlinewidth"><code class="tsd-tag">Optional</code><span>annotation<wbr/>Line<wbr/>Width</span><a href="#annotationlinewidth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
64
|
+
<div class="tsd-signature"><span class="tsd-kind-property">annotationLineWidth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
65
|
+
<div class="tsd-comment tsd-typography"><p>Stroke width in points applied to new ink annotations.</p>
|
|
66
|
+
</div><aside class="tsd-sources">
|
|
67
|
+
<ul>
|
|
68
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L109">ExpoPdfMarkup.types.ts:109</a></li></ul></aside></section>
|
|
69
|
+
<section class="tsd-panel tsd-member">
|
|
70
|
+
<h3 class="tsd-anchor-link" id="annotationmode"><code class="tsd-tag">Optional</code><span>annotation<wbr/>Mode</span><a href="#annotationmode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
71
|
+
<div class="tsd-signature"><span class="tsd-kind-property">annotationMode</span><span class="tsd-signature-symbol">?:</span> <a href="AnnotationMode.html" class="tsd-signature-type tsd-kind-type-alias">AnnotationMode</a></div>
|
|
72
|
+
<div class="tsd-comment tsd-typography"><p>Active annotation tool. Defaults to <code>'none'</code> (view-only).</p>
|
|
73
|
+
</div><aside class="tsd-sources">
|
|
74
|
+
<ul>
|
|
75
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L105">ExpoPdfMarkup.types.ts:105</a></li></ul></aside></section>
|
|
76
|
+
<section class="tsd-panel tsd-member">
|
|
77
|
+
<h3 class="tsd-anchor-link" id="annotations"><code class="tsd-tag">Optional</code><span>annotations</span><a href="#annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
78
|
+
<div class="tsd-signature"><span class="tsd-kind-property">annotations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
79
|
+
<div class="tsd-comment tsd-typography"><p>Serialised <a href="AnnotationsData.html" class="tsd-kind-type-alias">AnnotationsData</a> JSON string to load when the document opens.</p>
|
|
80
|
+
</div><aside class="tsd-sources">
|
|
81
|
+
<ul>
|
|
82
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L103">ExpoPdfMarkup.types.ts:103</a></li></ul></aside></section>
|
|
83
|
+
<section class="tsd-panel tsd-member">
|
|
84
|
+
<h3 class="tsd-anchor-link" id="backgroundcolor"><code class="tsd-tag">Optional</code><span>background<wbr/>Color</span><a href="#backgroundcolor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
85
|
+
<div class="tsd-signature"><span class="tsd-kind-property">backgroundColor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
86
|
+
<div class="tsd-comment tsd-typography"><p>Background colour shown behind the PDF pages.</p>
|
|
87
|
+
</div><aside class="tsd-sources">
|
|
88
|
+
<ul>
|
|
89
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L101">ExpoPdfMarkup.types.ts:101</a></li></ul></aside></section>
|
|
90
|
+
<section class="tsd-panel tsd-member">
|
|
91
|
+
<h3 class="tsd-anchor-link" id="onannotationschanged"><code class="tsd-tag">Optional</code><span>on<wbr/>Annotations<wbr/>Changed</span><a href="#onannotationschanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
92
|
+
<div class="tsd-signature"><span class="tsd-kind-property">onAnnotationsChanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">annotations</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div>
|
|
93
|
+
<div class="tsd-comment tsd-typography"><p>Fired after annotations are created or edited. <code>annotations</code> is a serialised <a href="AnnotationsData.html" class="tsd-kind-type-alias">AnnotationsData</a> JSON string.</p>
|
|
94
|
+
</div><aside class="tsd-sources">
|
|
95
|
+
<ul>
|
|
96
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L130">ExpoPdfMarkup.types.ts:130</a></li></ul></aside></section>
|
|
97
|
+
<section class="tsd-panel tsd-member">
|
|
98
|
+
<h3 class="tsd-anchor-link" id="onerror"><code class="tsd-tag">Optional</code><span>on<wbr/>Error</span><a href="#onerror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
99
|
+
<div class="tsd-signature"><span class="tsd-kind-property">onError</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div>
|
|
100
|
+
<div class="tsd-comment tsd-typography"><p>Fired when the document fails to load.</p>
|
|
101
|
+
</div><aside class="tsd-sources">
|
|
102
|
+
<ul>
|
|
103
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L128">ExpoPdfMarkup.types.ts:128</a></li></ul></aside></section>
|
|
104
|
+
<section class="tsd-panel tsd-member">
|
|
105
|
+
<h3 class="tsd-anchor-link" id="onloadcomplete"><code class="tsd-tag">Optional</code><span>on<wbr/>Load<wbr/>Complete</span><a href="#onloadcomplete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
106
|
+
<div class="tsd-signature"><span class="tsd-kind-property">onLoadComplete</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">pageCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div>
|
|
107
|
+
<div class="tsd-comment tsd-typography"><p>Fired once the document has finished loading.</p>
|
|
108
|
+
</div><aside class="tsd-sources">
|
|
109
|
+
<ul>
|
|
110
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L126">ExpoPdfMarkup.types.ts:126</a></li></ul></aside></section>
|
|
111
|
+
<section class="tsd-panel tsd-member">
|
|
112
|
+
<h3 class="tsd-anchor-link" id="onpagechanged"><code class="tsd-tag">Optional</code><span>on<wbr/>Page<wbr/>Changed</span><a href="#onpagechanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
113
|
+
<div class="tsd-signature"><span class="tsd-kind-property">onPageChanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">nativeEvent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">pageCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">pageHeight</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">pageWidth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div>
|
|
114
|
+
<div class="tsd-comment tsd-typography"><p>Fired when the visible page changes.</p>
|
|
115
|
+
</div><aside class="tsd-sources">
|
|
116
|
+
<ul>
|
|
117
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L122">ExpoPdfMarkup.types.ts:122</a></li></ul></aside></section>
|
|
118
|
+
<section class="tsd-panel tsd-member">
|
|
119
|
+
<h3 class="tsd-anchor-link" id="ontextinputrequested"><code class="tsd-tag">Optional</code><span>on<wbr/>Text<wbr/>Input<wbr/>Requested</span><a href="#ontextinputrequested" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
120
|
+
<div class="tsd-signature"><span class="tsd-kind-property">onTextInputRequested</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="TextInputRequest.html" class="tsd-signature-type tsd-kind-type-alias">TextInputRequest</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></div>
|
|
121
|
+
<div class="tsd-comment tsd-typography"><p>Optional async callback for the text annotation tool. When provided, this is called instead of
|
|
122
|
+
the native platform dialog (UIAlertController / AlertDialog) when the user taps to place a text
|
|
123
|
+
annotation. When editing an existing text annotation, <code>request.currentText</code> is populated and
|
|
124
|
+
<code>request.mode</code> is <code>'edit'</code>. Return the text string to create/update the annotation, or <code>null</code>
|
|
125
|
+
to cancel.</p>
|
|
126
|
+
</div><aside class="tsd-sources">
|
|
127
|
+
<ul>
|
|
128
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L138">ExpoPdfMarkup.types.ts:138</a></li></ul></aside></section>
|
|
129
|
+
<section class="tsd-panel tsd-member">
|
|
130
|
+
<h3 class="tsd-anchor-link" id="page"><code class="tsd-tag">Optional</code><span>page</span><a href="#page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
131
|
+
<div class="tsd-signature"><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
132
|
+
<div class="tsd-comment tsd-typography"><p>0-based page number to display. Can be used to restore scroll position on orientation change.</p>
|
|
133
|
+
</div><aside class="tsd-sources">
|
|
134
|
+
<ul>
|
|
135
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L99">ExpoPdfMarkup.types.ts:99</a></li></ul></aside></section>
|
|
136
|
+
<section class="tsd-panel tsd-member">
|
|
137
|
+
<h3 class="tsd-anchor-link" id="source"><span>source</span><a href="#source" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
138
|
+
<div class="tsd-signature"><span class="tsd-kind-property">source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
139
|
+
<div class="tsd-comment tsd-typography"><p>Absolute local file path of the PDF to display.</p>
|
|
140
|
+
</div><aside class="tsd-sources">
|
|
141
|
+
<ul>
|
|
142
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L97">ExpoPdfMarkup.types.ts:97</a></li></ul></aside></section>
|
|
143
|
+
<section class="tsd-panel tsd-member">
|
|
144
|
+
<h3 class="tsd-anchor-link" id="stampsize"><code class="tsd-tag">Optional</code><span>stamp<wbr/>Size</span><a href="#stampsize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
145
|
+
<div class="tsd-signature"><span class="tsd-kind-property">stampSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
146
|
+
<div class="tsd-comment tsd-typography"><p>Side length, in PDF points, of the square bounding box for newly placed stamps. Defaults to 48.</p>
|
|
147
|
+
</div><aside class="tsd-sources">
|
|
148
|
+
<ul>
|
|
149
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L120">ExpoPdfMarkup.types.ts:120</a></li></ul></aside></section>
|
|
150
|
+
<section class="tsd-panel tsd-member">
|
|
151
|
+
<h3 class="tsd-anchor-link" id="stamptext"><code class="tsd-tag">Optional</code><span>stamp<wbr/>Text</span><a href="#stamptext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
152
|
+
<div class="tsd-signature"><span class="tsd-kind-property">stampText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
153
|
+
<div class="tsd-comment tsd-typography"><p>Glyph or short string for the next stamp to place. Required for the <code>'stamp'</code> tool to place anything on tap.</p>
|
|
154
|
+
</div><aside class="tsd-sources">
|
|
155
|
+
<ul>
|
|
156
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L118">ExpoPdfMarkup.types.ts:118</a></li></ul></aside></section>
|
|
157
|
+
<section class="tsd-panel tsd-member">
|
|
158
|
+
<h3 class="tsd-anchor-link" id="style"><code class="tsd-tag">Optional</code><span>style</span><a href="#style" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
159
|
+
<div class="tsd-signature"><span class="tsd-kind-property">style</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StyleProp</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ViewStyle</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
|
160
|
+
<ul>
|
|
161
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L139">ExpoPdfMarkup.types.ts:139</a></li></ul></aside></section></section></details></div>
|
|
162
|
+
<div class="col-sidebar">
|
|
163
|
+
<div class="page-menu">
|
|
164
|
+
<div class="tsd-navigation settings">
|
|
165
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
166
|
+
<h3>Settings</h3></summary>
|
|
167
|
+
<div class="tsd-accordion-details">
|
|
168
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
169
|
+
<ul id="tsd-filter-options">
|
|
170
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
171
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
172
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
173
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
174
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
175
|
+
<h3>On This Page</h3></summary>
|
|
176
|
+
<div class="tsd-accordion-details">
|
|
177
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
178
|
+
<div><a href="#annotationcolor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Color</span></a><a href="#annotationfontfamily"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Font<wbr/>Family</span></a><a href="#annotationlinewidth"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Line<wbr/>Width</span></a><a href="#annotationmode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotation<wbr/>Mode</span></a><a href="#annotations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotations</span></a><a href="#backgroundcolor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>background<wbr/>Color</span></a><a href="#onannotationschanged"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Annotations<wbr/>Changed</span></a><a href="#onerror"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Error</span></a><a href="#onloadcomplete"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Load<wbr/>Complete</span></a><a href="#onpagechanged"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Page<wbr/>Changed</span></a><a href="#ontextinputrequested"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Text<wbr/>Input<wbr/>Requested</span></a><a href="#page"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page</span></a><a href="#source"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>source</span></a><a href="#stampsize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stamp<wbr/>Size</span></a><a href="#stamptext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stamp<wbr/>Text</span></a><a href="#style"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>style</span></a></div></details></div></details></div>
|
|
179
|
+
<div class="site-menu">
|
|
180
|
+
<nav class="tsd-navigation"><a href="../modules.html">@tobyt/expo-pdf-markup - v1.1.1</a>
|
|
181
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
182
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
183
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
184
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HighlightAnnotation | @tobyt/expo-pdf-markup - v1.1.1</title><meta name="description" content="Documentation for @tobyt/expo-pdf-markup"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@tobyt/expo-pdf-markup - v1.1.1</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">HighlightAnnotation</a></li></ul>
|
|
12
|
+
<h1>Type Alias HighlightAnnotation</h1></div>
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">HighlightAnnotation</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#alpha">alpha</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bounds">bounds</a><span class="tsd-signature-symbol">:</span> <a href="AnnotationBounds.html" class="tsd-signature-type tsd-kind-type-alias">AnnotationBounds</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#color">color</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#createdat">createdAt</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#page">page</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"highlight"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
14
|
+
<ul>
|
|
15
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L17">ExpoPdfMarkup.types.ts:17</a></li></ul></aside>
|
|
16
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
17
|
+
<section class="tsd-panel tsd-index-panel">
|
|
18
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
19
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
20
|
+
<div class="tsd-accordion-details">
|
|
21
|
+
<section class="tsd-index-section">
|
|
22
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
23
|
+
<div class="tsd-index-list"><a href="#alpha" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alpha?</span></a>
|
|
24
|
+
<a href="#bounds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bounds</span></a>
|
|
25
|
+
<a href="#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color</span></a>
|
|
26
|
+
<a href="#createdat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At?</span></a>
|
|
27
|
+
<a href="#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
|
28
|
+
<a href="#page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page</span></a>
|
|
29
|
+
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
30
|
+
</div></section></div></details></section></section>
|
|
31
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
32
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
33
|
+
<section>
|
|
34
|
+
<section class="tsd-panel tsd-member">
|
|
35
|
+
<h3 class="tsd-anchor-link" id="alpha"><code class="tsd-tag">Optional</code><span>alpha</span><a href="#alpha" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
36
|
+
<div class="tsd-signature"><span class="tsd-kind-property">alpha</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
37
|
+
<ul>
|
|
38
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L22">ExpoPdfMarkup.types.ts:22</a></li></ul></aside></section>
|
|
39
|
+
<section class="tsd-panel tsd-member">
|
|
40
|
+
<h3 class="tsd-anchor-link" id="bounds"><span>bounds</span><a href="#bounds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
41
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bounds</span><span class="tsd-signature-symbol">:</span> <a href="AnnotationBounds.html" class="tsd-signature-type tsd-kind-type-alias">AnnotationBounds</a></div><aside class="tsd-sources">
|
|
42
|
+
<ul>
|
|
43
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L23">ExpoPdfMarkup.types.ts:23</a></li></ul></aside></section>
|
|
44
|
+
<section class="tsd-panel tsd-member">
|
|
45
|
+
<h3 class="tsd-anchor-link" id="color"><span>color</span><a href="#color" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
46
|
+
<div class="tsd-signature"><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
47
|
+
<ul>
|
|
48
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L21">ExpoPdfMarkup.types.ts:21</a></li></ul></aside></section>
|
|
49
|
+
<section class="tsd-panel tsd-member">
|
|
50
|
+
<h3 class="tsd-anchor-link" id="createdat"><code class="tsd-tag">Optional</code><span>created<wbr/>At</span><a href="#createdat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
51
|
+
<div class="tsd-signature"><span class="tsd-kind-property">createdAt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
52
|
+
<ul>
|
|
53
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L24">ExpoPdfMarkup.types.ts:24</a></li></ul></aside></section>
|
|
54
|
+
<section class="tsd-panel tsd-member">
|
|
55
|
+
<h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
56
|
+
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
57
|
+
<ul>
|
|
58
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L18">ExpoPdfMarkup.types.ts:18</a></li></ul></aside></section>
|
|
59
|
+
<section class="tsd-panel tsd-member">
|
|
60
|
+
<h3 class="tsd-anchor-link" id="page"><span>page</span><a href="#page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
61
|
+
<div class="tsd-signature"><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
62
|
+
<ul>
|
|
63
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L20">ExpoPdfMarkup.types.ts:20</a></li></ul></aside></section>
|
|
64
|
+
<section class="tsd-panel tsd-member">
|
|
65
|
+
<h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
66
|
+
<div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"highlight"</span></div><aside class="tsd-sources">
|
|
67
|
+
<ul>
|
|
68
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L19">ExpoPdfMarkup.types.ts:19</a></li></ul></aside></section></section></details></div>
|
|
69
|
+
<div class="col-sidebar">
|
|
70
|
+
<div class="page-menu">
|
|
71
|
+
<div class="tsd-navigation settings">
|
|
72
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
73
|
+
<h3>Settings</h3></summary>
|
|
74
|
+
<div class="tsd-accordion-details">
|
|
75
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
76
|
+
<ul id="tsd-filter-options">
|
|
77
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
78
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
79
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
80
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
81
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
82
|
+
<h3>On This Page</h3></summary>
|
|
83
|
+
<div class="tsd-accordion-details">
|
|
84
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
85
|
+
<div><a href="#alpha"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alpha</span></a><a href="#bounds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bounds</span></a><a href="#color"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color</span></a><a href="#createdat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#page"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a></div></details></div></details></div>
|
|
86
|
+
<div class="site-menu">
|
|
87
|
+
<nav class="tsd-navigation"><a href="../modules.html">@tobyt/expo-pdf-markup - v1.1.1</a>
|
|
88
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
89
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
90
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
91
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InkAnnotation | @tobyt/expo-pdf-markup - v1.1.1</title><meta name="description" content="Documentation for @tobyt/expo-pdf-markup"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@tobyt/expo-pdf-markup - v1.1.1</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">InkAnnotation</a></li></ul>
|
|
12
|
+
<h1>Type Alias InkAnnotation</h1></div>
|
|
13
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">InkAnnotation</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#color">color</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#createdat">createdAt</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#linewidth">lineWidth</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#page">page</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#paths">paths</a><span class="tsd-signature-symbol">:</span> <a href="AnnotationPoint.html" class="tsd-signature-type tsd-kind-type-alias">AnnotationPoint</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ink"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
14
|
+
<ul>
|
|
15
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L7">ExpoPdfMarkup.types.ts:7</a></li></ul></aside>
|
|
16
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
17
|
+
<section class="tsd-panel tsd-index-panel">
|
|
18
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
19
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
20
|
+
<div class="tsd-accordion-details">
|
|
21
|
+
<section class="tsd-index-section">
|
|
22
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
23
|
+
<div class="tsd-index-list"><a href="#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color</span></a>
|
|
24
|
+
<a href="#createdat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At?</span></a>
|
|
25
|
+
<a href="#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
|
26
|
+
<a href="#linewidth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>line<wbr/>Width</span></a>
|
|
27
|
+
<a href="#page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page</span></a>
|
|
28
|
+
<a href="#paths" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths</span></a>
|
|
29
|
+
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
30
|
+
</div></section></div></details></section></section>
|
|
31
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
32
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
33
|
+
<section>
|
|
34
|
+
<section class="tsd-panel tsd-member">
|
|
35
|
+
<h3 class="tsd-anchor-link" id="color"><span>color</span><a href="#color" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
36
|
+
<div class="tsd-signature"><span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
37
|
+
<ul>
|
|
38
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L11">ExpoPdfMarkup.types.ts:11</a></li></ul></aside></section>
|
|
39
|
+
<section class="tsd-panel tsd-member">
|
|
40
|
+
<h3 class="tsd-anchor-link" id="createdat"><code class="tsd-tag">Optional</code><span>created<wbr/>At</span><a href="#createdat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
41
|
+
<div class="tsd-signature"><span class="tsd-kind-property">createdAt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
42
|
+
<ul>
|
|
43
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L14">ExpoPdfMarkup.types.ts:14</a></li></ul></aside></section>
|
|
44
|
+
<section class="tsd-panel tsd-member">
|
|
45
|
+
<h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
46
|
+
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
47
|
+
<ul>
|
|
48
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L8">ExpoPdfMarkup.types.ts:8</a></li></ul></aside></section>
|
|
49
|
+
<section class="tsd-panel tsd-member">
|
|
50
|
+
<h3 class="tsd-anchor-link" id="linewidth"><span>line<wbr/>Width</span><a href="#linewidth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
51
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lineWidth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
52
|
+
<ul>
|
|
53
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L12">ExpoPdfMarkup.types.ts:12</a></li></ul></aside></section>
|
|
54
|
+
<section class="tsd-panel tsd-member">
|
|
55
|
+
<h3 class="tsd-anchor-link" id="page"><span>page</span><a href="#page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
56
|
+
<div class="tsd-signature"><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
57
|
+
<ul>
|
|
58
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L10">ExpoPdfMarkup.types.ts:10</a></li></ul></aside></section>
|
|
59
|
+
<section class="tsd-panel tsd-member">
|
|
60
|
+
<h3 class="tsd-anchor-link" id="paths"><span>paths</span><a href="#paths" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
61
|
+
<div class="tsd-signature"><span class="tsd-kind-property">paths</span><span class="tsd-signature-symbol">:</span> <a href="AnnotationPoint.html" class="tsd-signature-type tsd-kind-type-alias">AnnotationPoint</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
62
|
+
<ul>
|
|
63
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L13">ExpoPdfMarkup.types.ts:13</a></li></ul></aside></section>
|
|
64
|
+
<section class="tsd-panel tsd-member">
|
|
65
|
+
<h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
66
|
+
<div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ink"</span></div><aside class="tsd-sources">
|
|
67
|
+
<ul>
|
|
68
|
+
<li>Defined in <a href="https://github.com/tobyt42/expo-pdf-markup/blob/f632112f16a9c9695af79990482a3b51b32ac893/src/ExpoPdfMarkup.types.ts#L9">ExpoPdfMarkup.types.ts:9</a></li></ul></aside></section></section></details></div>
|
|
69
|
+
<div class="col-sidebar">
|
|
70
|
+
<div class="page-menu">
|
|
71
|
+
<div class="tsd-navigation settings">
|
|
72
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
73
|
+
<h3>Settings</h3></summary>
|
|
74
|
+
<div class="tsd-accordion-details">
|
|
75
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
76
|
+
<ul id="tsd-filter-options">
|
|
77
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
78
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
79
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
80
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
81
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
82
|
+
<h3>On This Page</h3></summary>
|
|
83
|
+
<div class="tsd-accordion-details">
|
|
84
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
85
|
+
<div><a href="#color"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color</span></a><a href="#createdat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>created<wbr/>At</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#linewidth"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>line<wbr/>Width</span></a><a href="#page"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page</span></a><a href="#paths"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a></div></details></div></details></div>
|
|
86
|
+
<div class="site-menu">
|
|
87
|
+
<nav class="tsd-navigation"><a href="../modules.html">@tobyt/expo-pdf-markup - v1.1.1</a>
|
|
88
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
89
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
90
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
91
|
+
<div class="overlay"></div></body></html>
|