2 lines
8.4 KiB
JavaScript
2 lines
8.4 KiB
JavaScript
import{_ as a,a as r,b as t,ag as o}from"./chunks/framework.BcrMLAmg.js";const m=JSON.parse('{"title":"Graph","description":"","frontmatter":{},"headers":[],"relativePath":"references/elements/Graph.md","filePath":"references/elements/Graph.md","lastUpdated":1757844696000}'),s={name:"references/elements/Graph.md"};function i(h,e,d,n,l,c){return t(),r("div",null,e[0]||(e[0]=[o('<h1 id="graph" tabindex="-1">Graph <a class="header-anchor" href="#graph" aria-label="Permalink to "Graph""></a></h1><p><em>This is the base class for all graph elements. It is a point based graph.</em></p><p>Extends: <code>VisualElement</code></p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><table tabindex="0"><thead><tr><th>Property</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>minValue</td><td>number</td><td>0</td><td>The minimum value of the graph</td></tr><tr><td>maxValue</td><td>number</td><td>100</td><td>The maximum value of the graph</td></tr><tr><td>series</td><td>table</td><td>{}</td><td>The series of the graph</td></tr></tbody></table><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to "Functions""></a></h2><table tabindex="0"><thead><tr><th>Method</th><th>Returns</th><th>Description</th></tr></thead><tbody><tr><td><a href="#graph-addseries-name-symbol-bgcol-fgcol-pointcount">Graph:addSeries</a></td><td>Graph</td><td>Adds a series to the graph</td></tr><tr><td><a href="#graph-removeseries-name">Graph:removeSeries</a></td><td>Graph</td><td>Removes a series from the graph</td></tr><tr><td><a href="#graph-getseries-name">Graph:getSeries</a></td><td>series</td><td>Gets a series from the graph</td></tr><tr><td><a href="#graph-changeseriesvisibility-name-visible">Graph:changeSeriesVisibility</a></td><td>Graph</td><td>Changes the visibility of a series</td></tr><tr><td><a href="#graph-addpoint-name-value">Graph:addPoint</a></td><td>Graph</td><td>Adds a point to a series</td></tr><tr><td><a href="#graph-focusseries-name">Graph:focusSeries</a></td><td>Graph</td><td>Focuses a series</td></tr><tr><td><a href="#graph-setseriespointcount-name-count">Graph:setSeriesPointCount</a></td><td>Graph</td><td>Sets the point count of a series</td></tr><tr><td><a href="#graph-clear-name">Graph:clear</a></td><td>Graph</td><td>Clears all points from a series</td></tr></tbody></table><h2 id="graph-addseries-name-symbol-bgcol-fgcol-pointcount" tabindex="-1">Graph:addSeries(name, symbol, bgCol, fgCol, pointCount) <a class="header-anchor" href="#graph-addseries-name-symbol-bgcol-fgcol-pointcount" aria-label="Permalink to "Graph:addSeries(name, symbol, bgCol, fgCol, pointCount)""></a></h2><h3 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <code>string</code> The name of the series</li><li><code>symbol</code> <code>string</code> The symbol of the series</li><li><code>bgCol</code> <code>number</code> The background color of the series</li><li><code>fgCol</code> <code>number</code> The foreground color of the series</li><li><code>pointCount</code> <code>number</code> The number of points in the series</li></ul><h3 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h3><ul><li><code>Graph</code> <code>self</code> The graph instance</li></ul><h2 id="graph-removeseries-name" tabindex="-1">Graph:removeSeries(name) <a class="header-anchor" href="#graph-removeseries-name" aria-label="Permalink to "Graph:removeSeries(name)""></a></h2><h3 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <code>string</code> The name of the series</li></ul><h3 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h3><ul><li><code>Graph</code> <code>self</code> The graph instance</li></ul><h2 id="graph-getseries-name" tabindex="-1">Graph:getSeries(name) <a class="header-anchor" href="#graph-getseries-name" aria-label="Permalink to "Graph:getSeries(name)""></a></h2><h3 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <code>string</code> The name of the series</li></ul><h3 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to "Returns""></a></h3><ul><li><code>series</code> <code>The</code> series</li></ul><h2 id="graph-changeseriesvisibility-name-visible" tabindex="-1">Graph:changeSeriesVisibility(name, visible) <a class="header-anchor" href="#graph-changeseriesvisibility-name-visible" aria-label="Permalink to "Graph:changeSeriesVisibility(name, visible)""></a></h2><h3 id="parameters-3" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-3" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <code>string</code> The name of the series</li><li><code>visible</code> <code>boolean</code> Whether the series should be visible</li></ul><h3 id="returns-3" tabindex="-1">Returns <a class="header-anchor" href="#returns-3" aria-label="Permalink to "Returns""></a></h3><ul><li><code>Graph</code> <code>self</code> The graph instance</li></ul><h2 id="graph-addpoint-name-value" tabindex="-1">Graph:addPoint(name, value) <a class="header-anchor" href="#graph-addpoint-name-value" aria-label="Permalink to "Graph:addPoint(name, value)""></a></h2><h3 id="parameters-4" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-4" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <code>string</code> The name of the series</li><li><code>value</code> <code>number</code> The value of the point</li></ul><h3 id="returns-4" tabindex="-1">Returns <a class="header-anchor" href="#returns-4" aria-label="Permalink to "Returns""></a></h3><ul><li><code>Graph</code> <code>self</code> The graph instance</li></ul><h2 id="graph-focusseries-name" tabindex="-1">Graph:focusSeries(name) <a class="header-anchor" href="#graph-focusseries-name" aria-label="Permalink to "Graph:focusSeries(name)""></a></h2><h3 id="parameters-5" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-5" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <code>string</code> The name of the series</li></ul><h3 id="returns-5" tabindex="-1">Returns <a class="header-anchor" href="#returns-5" aria-label="Permalink to "Returns""></a></h3><ul><li><code>Graph</code> <code>self</code> The graph instance</li></ul><h2 id="graph-setseriespointcount-name-count" tabindex="-1">Graph:setSeriesPointCount(name, count) <a class="header-anchor" href="#graph-setseriespointcount-name-count" aria-label="Permalink to "Graph:setSeriesPointCount(name, count)""></a></h2><h3 id="parameters-6" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-6" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <code>string</code> The name of the series</li><li><code>count</code> <code>number</code> The number of points in the series</li></ul><h3 id="returns-6" tabindex="-1">Returns <a class="header-anchor" href="#returns-6" aria-label="Permalink to "Returns""></a></h3><ul><li><code>Graph</code> <code>self</code> The graph instance</li></ul><h2 id="graph-clear-name" tabindex="-1">Graph:clear(name?) <a class="header-anchor" href="#graph-clear-name" aria-label="Permalink to "Graph:clear(name?)""></a></h2><p>Clears all points from a series</p><h3 id="parameters-7" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-7" aria-label="Permalink to "Parameters""></a></h3><ul><li><code>name</code> <em>(optional)</em> <code>string</code> The name of the series</li></ul><h3 id="returns-7" tabindex="-1">Returns <a class="header-anchor" href="#returns-7" aria-label="Permalink to "Returns""></a></h3><ul><li><code>Graph</code> <code>self</code> The graph instance</li></ul>',48)]))}const p=a(s,[["render",i]]);export{m as __pageData,p as default};
|