298 lines
14 KiB
HTML
298 lines
14 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>DrawBox | @vladmandic/face-api</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/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</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</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<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.DrawBox.html">DrawBox</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class DrawBox</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">DrawBox</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="draw.DrawBox.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.DrawBox.html#box" class="tsd-kind-icon">box</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.DrawBox.html#options" class="tsd-kind-icon">options</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="draw.DrawBox.html#draw" class="tsd-kind-icon">draw</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Draw<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><a href="../interfaces/IRect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/IBoundingBox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/draw.IDrawBoxOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawBoxOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.DrawBox.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBox</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L43">draw/DrawBox.ts:43</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>box: <a href="../interfaces/IRect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/IBoundingBox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>options: <a href="../interfaces/draw.IDrawBoxOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawBoxOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="draw.DrawBox.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBox</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="box" class="tsd-anchor"></a>
|
|
<h3>box</h3>
|
|
<div class="tsd-signature tsd-kind-icon">box<span class="tsd-signature-symbol">:</span> <a href="Box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L39">draw/DrawBox.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="options" class="tsd-anchor"></a>
|
|
<h3>options</h3>
|
|
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="draw.DrawBoxOptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBoxOptions</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L41">draw/DrawBox.ts:41</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="draw" class="tsd-anchor"></a>
|
|
<h3>draw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>canvasArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L51">draw/DrawBox.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>canvasArg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../index.html">Exports</a>
|
|
</li>
|
|
<li class="current tsd-kind-namespace">
|
|
<a href="../modules/draw.html">draw</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="../modules/utils.html">utils</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
|
|
<a href="../enums/draw.AnchorPosition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-namespace">
|
|
<a href="draw.DrawBox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="draw.DrawBox.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="draw.DrawBox.html#box" class="tsd-kind-icon">box</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="draw.DrawBox.html#options" class="tsd-kind-icon">options</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="draw.DrawBox.html#draw" class="tsd-kind-icon">draw</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
|
<a href="draw.DrawBoxOptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
|
<a href="draw.DrawFaceLandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
|
<a href="draw.DrawFaceLandmarksOptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
|
<a href="draw.DrawTextField.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
|
<a href="draw.DrawTextFieldOptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
|
<a href="../interfaces/draw.IDrawBoxOptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
|
<a href="../interfaces/draw.IDrawFaceLandmarksOptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
|
<a href="../interfaces/draw.IDrawTextFieldOptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
|
|
<a href="../modules/draw.html#DrawFaceExpressionsInput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
|
|
<a href="../modules/draw.html#DrawFaceLandmarksInput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
|
|
<a href="../modules/draw.html#TDrawDetectionsInput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="../modules/draw.html#drawContour" class="tsd-kind-icon">draw<wbr>Contour</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="../modules/draw.html#drawDetections" class="tsd-kind-icon">draw<wbr>Detections</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="../modules/draw.html#drawFaceExpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="../modules/draw.html#drawFaceLandmarks" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |