Files
StepperView/docs/Structs/PitStopLineView.html
T
Badarinath Venkatnarayansetty 2d673ded07 JAzzy docs for 1.3.1 version
2020-05-03 18:43:35 -07:00

339 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en">
<head>
<title>PitStopLineView Structure Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Struct/PitStopLineView" class="dashAnchor"></a>
<a title="PitStopLineView Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">StepperView 1.3.1 Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">StepperView Reference</a>
<img id="carat" src="../img/carat.png" />
PitStopLineView Structure Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/Colors.html">Colors</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/GraySubType.html"> GraySubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/GreenSubType.html"> GreenSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/BlueSubType.html"> BlueSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/YellowSubType.html"> YellowSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/RedSubType.html"> RedSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/PitStopLineOptions.html">PitStopLineOptions</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperAlignment.html">StepperAlignment</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperIndicationType.html">StepperIndicationType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperLineOptions.html">StepperLineOptions</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperMode.html">StepperMode</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/EnvironmentValues.html">EnvironmentValues</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/VerticalAlignment.html">VerticalAlignment</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/View.html">View</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/AlignmentKey.html">AlignmentKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/BoundsPreferenceKey.html">BoundsPreferenceKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/CGRectData.html">CGRectData</a>
</li>
<li class="nav-group-task">
<a href="../Structs/CGRectPreferenceKey.html">CGRectPreferenceKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/CircledIconView.html">CircledIconView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HeightKey.html">HeightKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HeightPreference.html">HeightPreference</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HorizontalLineView.html">HorizontalLineView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/IndicatorKey.html">IndicatorKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/IndicatorView.html">IndicatorView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/LineOptionsKey.html">LineOptionsKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/NumberedCircleView.html">NumberedCircleView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopLineView.html">PitStopLineView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopOptionsKey.html">PitStopOptionsKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopStep.html">PitStopStep</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopView.html">PitStopView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SpacingKey.html">SpacingKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepIndicatorHorizontalView.html">StepIndicatorHorizontalView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepIndicatorModeKey.html">StepIndicatorModeKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepIndicatorVerticalView.html">StepIndicatorVerticalView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepperView.html">StepperView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepsKey.html">StepsKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/TextView.html">TextView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Utils.html">Utils</a>
</li>
<li class="nav-group-task">
<a href="../Structs/VerticalHeightPreference.html">VerticalHeightPreference</a>
</li>
<li class="nav-group-task">
<a href="../Structs/VerticalLineView.html">VerticalLineView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/WidthKey.html">WidthKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/WidthPreference.html">WidthPreference</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>PitStopLineView</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">@available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *)</span>
<span class="kd">struct</span> <span class="kt">PitStopLineView</span> <span class="p">:</span> <span class="kt">View</span></code></pre>
</div>
</div>
<p>pitstop Line View for each of the step indicator</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:11StepperView011PitStopLineB0V7optionsAA0cdE7OptionsOvp"></a>
<a name="//apple_ref/swift/Property/options" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView011PitStopLineB0V7optionsAA0cdE7OptionsOvp">options</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>options for customizing pitstop line with either <code>defaults</code> or custom <code><a href="../Structs/PitStopLineView.html#/s:11StepperView011PitStopLineB0V5width12CoreGraphics7CGFloatVvp">width</a></code> and <code>Color</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Enums/PitStopLineOptions.html">PitStopLineOptions</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView011PitStopLineB0V5proxy7SwiftUI13GeometryProxyVvp"></a>
<a name="//apple_ref/swift/Property/proxy" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView011PitStopLineB0V5proxy7SwiftUI13GeometryProxyVvp">proxy</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>co-ordinates values of step indicator</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">proxy</span><span class="p">:</span> <span class="kt">GeometryProxy</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView011PitStopLineB0V5value7SwiftUI6AnchorVySo6CGRectVGvp"></a>
<a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView011PitStopLineB0V5value7SwiftUI6AnchorVySo6CGRectVGvp">value</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>bound values of step indicator</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Anchor</span><span class="o">&lt;</span><span class="kt">CGRect</span><span class="o">&gt;</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView011PitStopLineB0V5width12CoreGraphics7CGFloatVvp"></a>
<a name="//apple_ref/swift/Property/width" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView011PitStopLineB0V5width12CoreGraphics7CGFloatVvp">width</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>binding variable to hold width of the <code>View</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@Binding</span>
<span class="k">var</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="p">{</span> <span class="k">get</span> <span class="k">nonmutating</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView011PitStopLineB0V4bodyQrvp"></a>
<a name="//apple_ref/swift/Property/body" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView011PitStopLineB0V4bodyQrvp">body</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>provides the content and behavior of this view.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="n">some</span> <span class="kt">View</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/badrinathvm/StepperView" target="_blank" rel="external">badrinathvm</a>. All rights reserved. (Last updated: 2020-05-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>