dataforge-core/dataforge-context/space.kscience.dataforge.properties/index.html

205 lines
21 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.dataforge.properties</title>
</head><body><link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script><script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../scripts/clipboard.js" async></script><script type="text/javascript" src="../../scripts/navigation-loader.js" async></script><script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script><script type="text/javascript" src="../../scripts/main.js" async></script>
<div id="container">
<div id="leftColumn"><a href="../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<script type="text/javascript" src="../../scripts/main.js"></script><div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="main-content" id="content" pageids="dataforge-context::space.kscience.dataforge.properties////PointingToDeclaration//-1500108830">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../index.html">dataforge-context</a>/<a href="index.html">space.kscience.dataforge.properties</a></div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector common-like" data-active="" data-filter=":dataforge-context:dokkaHtmlPartial/commonMain">common</button><button class="platform-tag platform-selector js-like" data-active="" data-filter=":dataforge-context:dokkaHtmlPartial/jsMain">js</button></div>
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span><span>Package</span></span> <span>space.</span><wbr><span>kscience.</span><wbr><span>dataforge.</span><wbr><span>properties</span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="819431129%2FClasslikes%2F966590886" anchor-label="MetaProperty" id="819431129%2FClasslikes%2F966590886" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-meta-property/index.html"><span>Meta</span><wbr><span><span>Property</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="819431129%2FClasslikes%2F966590886"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="symbol monospace">class <a href="-meta-property/index.html">MetaProperty</a>&lt;<a href="-meta-property/index.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt;(meta: <a href="../../dataforge-meta/space.kscience.dataforge.meta/-observable-mutable-meta/index.html">ObservableMutableMeta</a>, name: <a href="../../dataforge-meta/space.kscience.dataforge.names/-name/index.html">Name</a>, converter: <a href="../../dataforge-meta/space.kscience.dataforge.meta.transformations/-meta-converter/index.html">MetaConverter</a>&lt;<a href="-meta-property/index.html">T</a>&gt;) : <a href="-property/index.html">Property</a>&lt;<a href="-meta-property/index.html">T</a>?&gt; <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-1845556898%2FClasslikes%2F966590886" anchor-label="Property" id="-1845556898%2FClasslikes%2F966590886" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="-property/index.html"><span><span>Property</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1845556898%2FClasslikes%2F966590886"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="symbol monospace">interface <a href="-property/index.html">Property</a>&lt;<a href="-property/index.html">T</a>&gt;<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-1496503055%2FFunctions%2F966590886" anchor-label="bind" id="-1496503055%2FFunctions%2F966590886" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="bind.html"><span><span>bind</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1496503055%2FFunctions%2F966590886"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun &lt;<a href="bind.html">T</a>&gt; <a href="-property/index.html">Property</a>&lt;<a href="bind.html">T</a>&gt;.<a href="bind.html">bind</a>(other: <a href="-property/index.html">Property</a>&lt;<a href="bind.html">T</a>&gt;)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<div class="brief "><p class="paragraph">Bi-directional connection between properties</p></div></div>
</div>
</div>
</div>
</div>
<a data-name="816129573%2FFunctions%2F128356936" anchor-label="bindChecked" id="816129573%2FFunctions%2F128356936" data-filterable-set=":dataforge-context:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/jsMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="bind-checked.html"><span>bind</span><wbr><span><span>Checked</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="816129573%2FFunctions%2F128356936"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag js-like">js</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/jsMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/jsMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/jsMain"><div class="symbol monospace">fun <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-h-t-m-l-input-element/index.html">HTMLInputElement</a>.<a href="bind-checked.html">bindChecked</a>(property: <a href="../../dataforge-context/space.kscience.dataforge.properties/-property/index.html">Property</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>&gt;)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-349273498%2FFunctions%2F128356936" anchor-label="bindValue" id="-349273498%2FFunctions%2F128356936" data-filterable-set=":dataforge-context:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/jsMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="bind-value.html"><span>bind</span><wbr><span><span>Value</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-349273498%2FFunctions%2F128356936"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag js-like">js</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/jsMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/jsMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/jsMain"><div class="symbol monospace">fun <a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-h-t-m-l-input-element/index.html">HTMLInputElement</a>.<a href="bind-value.html">bindValue</a>(property: <a href="../../dataforge-context/space.kscience.dataforge.properties/-property/index.html">Property</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt;)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-2140898705%2FFunctions%2F966590886" anchor-label="mirror" id="-2140898705%2FFunctions%2F966590886" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="mirror.html"><span><span>mirror</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2140898705%2FFunctions%2F966590886"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun &lt;<a href="mirror.html">T</a>&gt; <a href="-property/index.html">Property</a>&lt;<a href="mirror.html">T</a>&gt;.<a href="mirror.html">mirror</a>(source: <a href="-property/index.html">Property</a>&lt;<a href="mirror.html">T</a>&gt;)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<div class="brief "><p class="paragraph">Reflect all changes in the <a href="mirror.html">source</a> property onto this property. Does not reflect changes back.</p></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1474086278%2FFunctions%2F966590886" anchor-label="property" id="-1474086278%2FFunctions%2F966590886" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="property.html"><span><span>property</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1474086278%2FFunctions%2F966590886"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun &lt;<a href="property.html">S</a> : <a href="../../dataforge-meta/space.kscience.dataforge.meta/-scheme/index.html">Scheme</a>, <a href="property.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt; <a href="property.html">S</a>.<a href="property.html">property</a>(property: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-mutable-property1/index.html">KMutableProperty1</a>&lt;<a href="property.html">S</a>, <a href="property.html">T</a>?&gt;): <a href="-property/index.html">Property</a>&lt;<a href="property.html">T</a>?&gt;<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-1540893701%2FFunctions%2F966590886" anchor-label="toFlow" id="-1540893701%2FFunctions%2F966590886" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="to-flow.html"><span>to</span><wbr><span><span>Flow</span></span></a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1540893701%2FFunctions%2F966590886"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="platform-tags ">
<div class="platform-tag common-like">common</div>
</div>
<div class="title"><div class="divergent-group" data-filterable-current=":dataforge-context:dokkaHtmlPartial/commonMain" data-filterable-set=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dataforge-context:dokkaHtmlPartial/commonMain"><div class="symbol monospace">fun &lt;<a href="to-flow.html">T</a>&gt; <a href="-property/index.html">Property</a>&lt;<a href="to-flow.html">T</a>&gt;.<a href="to-flow.html">toFlow</a>(): <span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span>&lt;<a href="to-flow.html">T</a>&gt;<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body></html>