face-api/typedoc/classes/draw.DrawTextFieldOptions.html

8 lines
31 KiB
HTML
Raw Normal View History

2024-02-07 17:20:36 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DrawTextFieldOptions | @vladmandic/face-api - v1.7.13</title><meta name="description" content="Documentation for @vladmandic/face-api"/><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/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"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vladmandic/face-api - v1.7.13</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@vladmandic/face-api</a></li><li><a href="../modules/draw.html">draw</a></li><li><a href="draw.DrawTextFieldOptions.html">DrawTextFieldOptions</a></li></ul><h1>Class DrawTextFieldOptions</h1></div><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/draw.IDrawTextFieldOptions.html" class="tsd-signature-type tsd-kind-interface">IDrawTextFieldOptions</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/draw/DrawTextField.ts#L27">src/draw/DrawTextField.ts:27</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="draw.DrawTextFieldOptions.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
2024-01-17 22:56:53 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="draw.DrawTextFieldOptions.html#anchorPosition" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>anchor<wbr/>Position</span></a>
<a href="draw.DrawTextFieldOptions.html#backgroundColor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>background<wbr/>Color</span></a>
<a href="draw.DrawTextFieldOptions.html#fontColor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>font<wbr/>Color</span></a>
<a href="draw.DrawTextFieldOptions.html#fontSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>font<wbr/>Size</span></a>
<a href="draw.DrawTextFieldOptions.html#fontStyle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>font<wbr/>Style</span></a>
<a href="draw.DrawTextFieldOptions.html#padding" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>padding</span></a>
2024-02-07 17:20:36 +01:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_DrawTextFieldOptions" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Draw<wbr/>Text<wbr/>Field<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.DrawTextFieldOptions.html" class="tsd-signature-type tsd-kind-class">DrawTextFieldOptions</a><a href="#constructor.new_DrawTextFieldOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/draw.IDrawTextFieldOptions.html" class="tsd-signature-type tsd-kind-interface">IDrawTextFieldOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="draw.DrawTextFieldOptions.html" class="tsd-signature-type tsd-kind-class">DrawTextFieldOptions</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/draw/DrawTextField.ts#L40">src/draw/DrawTextField.ts:40</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="anchorPosition" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>anchor<wbr/>Position</span><a href="#anchorPosition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">anchor<wbr/>Position</span><span class="tsd-signature-symbol">:</span> <a href="../enums/draw.AnchorPosition.html" class="tsd-signature-type tsd-kind-enum">AnchorPosition</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/draw.IDrawTextFieldOptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.IDrawTextFieldOptions.html#anchorPosition">anchorPosition</a></p><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/draw/DrawTextField.ts#L28">src/draw/DrawTextField.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="backgroundColor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>background<wbr/>Color</span><a href="#backgroundColor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">background<wbr/>Color</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/draw.IDrawTextFieldOptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.IDrawTextFieldOptions.html#backgroundColor">backgroundColor</a></p><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/draw/DrawTextField.ts#L30">src/draw/DrawTextField.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fontColor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>font<wbr/>Color</span><a href="#fontColor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">font<wbr/>Color</span><span