first commit
This commit is contained in:
176
streamlit_dashboard/docs/_build/html/streamlit_dashboard.components.html
vendored
Normal file
176
streamlit_dashboard/docs/_build/html/streamlit_dashboard.components.html
vendored
Normal file
@@ -0,0 +1,176 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en" data-content_root="./">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>streamlit_dashboard.components namespace — Streamlit Dashboard 1.0 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
|
||||
<script src="_static/documentation_options.js?v=f2a433a1"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="streamlit_dashboard.page_classes namespace" href="streamlit_dashboard.page_classes.html" />
|
||||
<link rel="prev" title="streamlit_dashboard.cached_function_wrappers namespace" href="streamlit_dashboard.cached_function_wrappers.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-streamlit_dashboard.components">
|
||||
<span id="streamlit-dashboard-components-namespace"></span><h1>streamlit_dashboard.components namespace<a class="headerlink" href="#module-streamlit_dashboard.components" title="Link to this heading">¶</a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<section id="module-streamlit_dashboard.components.neoserra_export_link_grabber">
|
||||
<span id="streamlit-dashboard-components-neoserra-export-link-grabber-module"></span><h2>streamlit_dashboard.components.neoserra_export_link_grabber module<a class="headerlink" href="#module-streamlit_dashboard.components.neoserra_export_link_grabber" title="Link to this heading">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="streamlit_dashboard.components.neoserra_export_link_grabber.NeoserraExportLinkGrabber">
|
||||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">streamlit_dashboard.components.neoserra_export_link_grabber.</span></span><span class="sig-name descname"><span class="pre">NeoserraExportLinkGrabber</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">grabber_title</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prev_fy_initial_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">current_fy_initial_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.components.neoserra_export_link_grabber.NeoserraExportLinkGrabber" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Renderable</span></code></p>
|
||||
<p>Reusable UI component for capturing paired API endpoint URLs.</p>
|
||||
<p>This class encapsulates the state and presentation logic for modifying external data
|
||||
endpoints. By grouping the current and previous fiscal period URLs into a single
|
||||
renderable object, it standardizes the visual layout across the Admin Panel and
|
||||
isolates the input-capture logic from the parent page’s batch validation pipeline.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>grabber_title</strong> (<em>str</em>) – The unique display name for this URL grouping (e.g., ‘Client List’).</p></li>
|
||||
<li><p><strong>prev_fy_initial_value</strong> (<em>str</em>) – The existing configuration URL for the previous fiscal period.</p></li>
|
||||
<li><p><strong>current_fy_initial_value</strong> (<em>str</em>) – The existing configuration URL for the current fiscal period.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="streamlit_dashboard.components.neoserra_export_link_grabber.NeoserraExportLinkGrabber.get_widget_key">
|
||||
<span class="sig-name descname"><span class="pre">get_widget_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">widget_unique_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#streamlit_dashboard.components.neoserra_export_link_grabber.NeoserraExportLinkGrabber.get_widget_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Generates globally unique identifiers for the component’s internal Streamlit widgets.</p>
|
||||
<p>Because the Admin Panel renders multiple instances of this exact class on the same page,
|
||||
this method prevents Streamlit <cite>DuplicateWidgetID</cite> execution crashes by prefixing the
|
||||
local widget ID (e.g., ‘prev_fy_url_text_input’) with the instance’s unique title.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>widget_unique_id</strong> (<em>str</em>) – The local identifier for the specific text input widget.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>A concatenated, globally unique string key.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>str</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="streamlit_dashboard.components.neoserra_export_link_grabber.NeoserraExportLinkGrabber.render">
|
||||
<span class="sig-name descname"><span class="pre">render</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DeltaGenerator</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.components.neoserra_export_link_grabber.NeoserraExportLinkGrabber.render" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maps the URL capture inputs to the provided Streamlit layout container.</p>
|
||||
<p>Constructs a visually distinct, bordered container to group the paired fiscal period
|
||||
endpoints together. It binds the text input widgets to the component’s internal state,
|
||||
allowing the parent orchestrator to extract the modified strings during the form
|
||||
submission phase.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>container</strong> (<em>DeltaGenerator</em>) – The Streamlit layout container (typically a form) to draw the widgets onto.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">Streamlit Dashboard</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<search id="searchbox" style="display: none" role="search">
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</search>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">streamlit_dashboard</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="streamlit_dashboard.html">streamlit_dashboard namespace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li><a href="modules.html">streamlit_dashboard</a><ul>
|
||||
<li><a href="streamlit_dashboard.html">streamlit_dashboard namespace</a><ul>
|
||||
<li>Previous: <a href="streamlit_dashboard.cached_function_wrappers.html" title="previous chapter">streamlit_dashboard.cached_function_wrappers namespace</a></li>
|
||||
<li>Next: <a href="streamlit_dashboard.page_classes.html" title="next chapter">streamlit_dashboard.page_classes namespace</a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2026, SBDC Team.
|
||||
|
||||
|
|
||||
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 9.1.0</a>
|
||||
& <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
||||
|
||||
|
|
||||
<a href="_sources/streamlit_dashboard.components.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user