Google Git
Sign in
apache / sis-site / 742f5abfede39cb998f99b1d3128f30817895bb1 / . / org / apache / sis / gui / coverage / CoverageExplorer.html
blob: 20ba4f2028d2b16a09537f994613decd986c27e2 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>CoverageExplorer (Apache SIS 1.3 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.sis.gui.coverage, class: CoverageExplorer">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.gui.coverage.CoverageExplorer class">
<meta name="keywords" content="viewTypeProperty">
<meta name="keywords" content="resourceProperty">
<meta name="keywords" content="coverageProperty">
<meta name="keywords" content="getWindowHandler()">
<meta name="keywords" content="getCanvas()">
<meta name="keywords" content="getView()">
<meta name="keywords" content="getDataView()">
<meta name="keywords" content="getControls()">
<meta name="keywords" content="getViewType()">
<meta name="keywords" content="setViewType()">
<meta name="keywords" content="getResource()">
<meta name="keywords" content="setResource()">
<meta name="keywords" content="getCoverage()">
<meta name="keywords" content="setCoverage()">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/CoverageExplorer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li><a href="#nested-class-summary">Nested</a></li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li><a href="#field-detail">Field</a></li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.gui.coverage</a></div>
<h1 title="Class CoverageExplorer" class="title">Class CoverageExplorer</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance"><a href="../Widget.html" title="class in org.apache.sis.gui">Widget</a>
<div class="inheritance">CoverageExplorer</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@DefaultProperty("coverage")
</span><span class="modifiers">public class </span><span class="element-name type-name-label">CoverageExplorer</span>
<span class="extends-implements">extends <a href="../Widget.html" title="class in org.apache.sis.gui">Widget</a></span></div>
<div class="block">An image or tabular view of <a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid"><code>Grid­Coverage</code></a> together with controls for band selection and other operations.
The class contains two properties:
<ul>
<li>A <a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid"><code>Grid­Coverage</code></a> supplied by user.
May be specified indirectly with an <a href="ImageRequest.html" title="class in org.apache.sis.gui.coverage"><code>Image­Request</code></a> for loading the coverage.</li>
<li>A <a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage"><code>Coverage­Explorer​.View</code></a> type which specify how to show the coverage:
<ul>
<li>using <a href="GridView.html" title="class in org.apache.sis.gui.coverage"><code>Grid­View</code></a> for showing numerical values in a table, or</li>
<li>using <a href="CoverageCanvas.html" title="class in org.apache.sis.gui.coverage"><code>Coverage­Canvas</code></a> for showing the coverage as an image.</li>
</ul>
</li>
</ul>
Controls are provided for allowing user to customize map projection, number formats, <i>etc.</i>.
The set of control depends on the view type.
<h2>Limitations</h2>
Current implementation is restricted to <a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid"><code>Grid­Coverage</code></a> instances, but a future
implementation may generalize to <code>org​.opengis​.coverage​.Coverage</code> instances.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.1</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="CoverageCanvas.html" title="class in org.apache.sis.gui.coverage"><code>Coverage­Canvas</code></a></li>
<li><a href="GridView.html" title="class in org.apache.sis.gui.coverage"><code>Grid­View</code></a></li>
</ul>
</dd>
<p><font size="-1">Defined in the <code>sis-javafx</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="CoverageExplorer.View.html" class="type-name-link" title="enum class in org.apache.sis.gui.coverage">Coverage­Explorer​.View</a></code></div>
<div class="col-last even-row-color">
<div class="block">Type of view shown in the explorer.</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>final Object­Property&lt;<a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">Grid­Coverage</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#coverageProperty" class="member-name-link">coverage­Property</a></code></div>
<div class="col-last even-row-color">
<div class="block">The data shown in this canvas.</div>
</div>
<div class="col-first odd-row-color"><code>final Object­Property&lt;<a href="../../storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">Grid­Coverage­Resource</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#resourceProperty" class="member-name-link">resource­Property</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The source of coverage data shown in this explorer.</div>
</div>
<div class="col-first even-row-color"><code>final Object­Property&lt;<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">Coverage­Explorer​.View</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#viewTypeProperty" class="member-name-link">view­Type­Property</a></code></div>
<div class="col-last even-row-color">
<div class="block">The type of view (image or tabular data) shown in this explorer.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Coverage­Explorer</a>()</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="#%3Cinit%3E(org.apache.sis.gui.coverage.CoverageExplorer.View)"><code>Coverage­Explorer(View)</code></a>.</div>
</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.gui.coverage.CoverageExplorer)" class="member-name-link">Coverage­Explorer</a><wbr>(<a href="CoverageExplorer.html" title="class in org.apache.sis.gui.coverage">Coverage­Explorer</a>&nbsp;source)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates an explorer initialized with the same coverage or resource than the given explorer.</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.gui.coverage.CoverageExplorer.View)" class="member-name-link">Coverage­Explorer</a><wbr>(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">Coverage­Explorer​.View</a>&nbsp;type)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates an initially empty explorer with the specified view type.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="CoverageCanvas.html" title="class in org.apache.sis.gui.coverage">Coverage­Canvas</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCanvas()" class="member-name-link">get­Canvas</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the canvas where the image is shown.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final Titled­Pane[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getControls(org.apache.sis.gui.coverage.CoverageExplorer.View)" class="member-name-link">get­Controls</a><wbr>(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">Coverage­Explorer​.View</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the panes containing the controls, without data visualization component.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">Grid­Coverage</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoverage()" class="member-name-link">get­Coverage</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the source of sample values for this explorer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final Region</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataView(org.apache.sis.gui.coverage.CoverageExplorer.View)" class="member-name-link">get­Data­View</a><wbr>(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">Coverage­Explorer​.View</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the region containing the data visualization component, without controls other than navigation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../../storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">Grid­Coverage­Resource</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResource()" class="member-name-link">get­Resource</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the source of coverages for this explorer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final Region</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getView()" class="member-name-link">get­View</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the region containing the grid or coverage view, band selector and any control managed by this
<code>Coverage­Explorer</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">Coverage­Explorer​.View</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getViewType()" class="member-name-link">get­View­Type</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the type of view (image or tabular data) shown in this explorer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../dataset/WindowHandler.html" title="class in org.apache.sis.gui.dataset">Window­Handler</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWindowHandler()" class="member-name-link">get­Window­Handler</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the handler of the window showing this coverage view.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCoverage(org.apache.sis.coverage.grid.GridCoverage)" class="member-name-link">set­Coverage</a><wbr>(<a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">Grid­Coverage</a>&nbsp;coverage)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the coverage to show in this explorer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCoverage(org.apache.sis.gui.coverage.ImageRequest)" class="member-name-link">set­Coverage</a><wbr>(<a href="ImageRequest.html" title="class in org.apache.sis.gui.coverage">Image­Request</a>&nbsp;source)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Loads coverage in a background thread from the given source.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setResource(org.apache.sis.storage.GridCoverageResource)" class="member-name-link">set­Resource</a><wbr>(<a href="../../storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">Grid­Coverage­Resource</a>&nbsp;resource)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the source of coverages shown in this explorer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setViewType(org.apache.sis.gui.coverage.CoverageExplorer.View)" class="member-name-link">set­View­Type</a><wbr>(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">Coverage­Explorer​.View</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the type of view to show in this explorer.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Widget">Methods inherited from class&nbsp;<a href="../Widget.html" title="class in org.apache.sis.gui">Widget</a></h3>
<code><a href="../Widget.html#getLocale()">get­Locale</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="viewTypeProperty">
<h3>viewTypeProperty</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">ObjectProperty&lt;<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">CoverageExplorer.View</a>&gt;</span>&nbsp;<span class="element-name">viewTypeProperty</span></div>
<div class="block">The type of view (image or tabular data) shown in this explorer.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#getViewType()"><code>get­View­Type()</code></a></li>
<li><a href="#setViewType(org.apache.sis.gui.coverage.CoverageExplorer.View)"><code>set­View­Type(View)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="resourceProperty">
<h3>resourceProperty</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">ObjectProperty&lt;<a href="../../storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a>&gt;</span>&nbsp;<span class="element-name">resourceProperty</span></div>
<div class="block">The source of coverage data shown in this explorer. If this property value is non-null,
then <a href="#coverageProperty"><code>coverage­Property</code></a> value will change at any time (potentially many times)
depending on the zoom level or other user interaction. Conversely if a value is set
explicitly on <a href="#coverageProperty"><code>coverage­Property</code></a>, then this <code>resource­Property</code> is cleared.
<h4>Relationship with view properties</h4>
This property is "weakly bound" to <a href="CoverageCanvas.html#resourceProperty"><code>Coverage­Canvas​.resource­Property</code></a>:
the two properties generally have the same value but are not necessarily updated in same time.
After a value is set on one property, the other property may be updated only after some background process
(e.g. loading) finished. If a view is not the <a href="#getViewType()">currently visible view</a>,
its property may be updated only when the view become visible.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.2</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#getResource()"><code>get­Resource()</code></a></li>
<li><a href="#setResource(org.apache.sis.storage.GridCoverageResource)"><code>set­Resource(Grid­Coverage­Resource)</code></a></li>
<li><a href="CoverageCanvas.html#resourceProperty"><code>Coverage­Canvas​.resource­Property</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="coverageProperty">
<h3>coverageProperty</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">ObjectProperty&lt;<a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a>&gt;</span>&nbsp;<span class="element-name">coverageProperty</span></div>
<div class="block">The data shown in this canvas. This property value may be set implicitly or explicitly:
<ul>
<li>If the <a href="#resourceProperty"><code>resource­Property</code></a> value is non-null, then the value will change
automatically at any time (potentially many times) depending on user interaction.</li>
<li>Conversely if an explicit value is set on this property,
then the <a href="#resourceProperty"><code>resource­Property</code></a> is cleared.</li>
</ul>
Note that a change in this property value may not modify the canvas content immediately.
Instead, a background process will request the tiles and update the canvas content later,
when data are ready.
<p>Current implementation is restricted to <a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid"><code>Grid­Coverage</code></a> instances, but a future
implementation may generalize to <code>org​.opengis​.coverage​.Coverage</code> instances.</p>
<h4>Relationship with view properties</h4>
This property is "weakly bound" to <a href="CoverageCanvas.html#coverageProperty"><code>Coverage­Canvas​.coverage­Property</code></a>:
the two properties generally have the same value but are not necessarily updated in same time.
After a value is set on one property, the other property may be updated only after some background process
(e.g. loading) finished. If a view is not the <a href="#getViewType()">currently visible view</a>,
its property may be updated only when the view become visible.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#getCoverage()"><code>get­Coverage()</code></a></li>
<li><a href="#setCoverage(org.apache.sis.coverage.grid.GridCoverage)"><code>set­Coverage(Grid­Coverage)</code></a></li>
<li><a href="#setCoverage(org.apache.sis.gui.coverage.ImageRequest)"><code>set­Coverage(Image­Request)</code></a></li>
<li><a href="CoverageCanvas.html#coverageProperty"><code>Coverage­Canvas​.coverage­Property</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>CoverageExplorer</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="element-name">CoverageExplorer</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="#%3Cinit%3E(org.apache.sis.gui.coverage.CoverageExplorer.View)"><code>Coverage­Explorer(View)</code></a>.</div>
</div>
<div class="block">Creates an initially empty explorer with default view type.
By default <code>Coverage­Explorer</code> will show a coverage as a table of values,
i.e. the default view type is <a href="CoverageExplorer.View.html#TABLE"><code>Coverage­Explorer​.View​.TABLE</code></a>.
<div class="note"><b>API note:</b>
the reason for setting default value to tabular data is because it requires loading much less data with
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link"><code>Rendered­Image</code></a>s supporting deferred tile loading. By contrast <a href="CoverageExplorer.View.html#IMAGE"><code>Coverage­Explorer​.View​.IMAGE</code></a>
may require loading the full image.</div></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.sis.gui.coverage.CoverageExplorer.View)">
<h3>CoverageExplorer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CoverageExplorer</span><wbr><span class="parameters">(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">CoverageExplorer.View</a>&nbsp;type)</span></div>
<div class="block">Creates an initially empty explorer with the specified view type.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - the way to show coverages in this explorer.</dd>
<dt>Since:</dt>
<dd>1.2</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#setViewType(org.apache.sis.gui.coverage.CoverageExplorer.View)"><code>set­View­Type(View)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.sis.gui.coverage.CoverageExplorer)">
<h3>CoverageExplorer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CoverageExplorer</span><wbr><span class="parameters">(<a href="CoverageExplorer.html" title="class in org.apache.sis.gui.coverage">CoverageExplorer</a>&nbsp;source)</span></div>
<div class="block">Creates an explorer initialized with the same coverage or resource than the given explorer.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>source</code> - the source explorer from which to take the initial coverage or resource.</dd>
<dt>Since:</dt>
<dd>1.2</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getWindowHandler()">
<h3>getWindowHandler</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../dataset/WindowHandler.html" title="class in org.apache.sis.gui.dataset">WindowHandler</a></span>&nbsp;<span class="element-name">getWindowHandler</span>()</div>
<div class="block">Returns the handler of the window showing this coverage view.
Those windows are created when the user clicks on the "New window" button.
Each window provides the area where data are shown and where the user interacts.
The window can be a JavaFX top-level window (<code>Stage</code>), but not necessarily.
It may also be a tile in a mosaic of windows.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the handler of the window showing this coverage view.</dd>
<dt>Since:</dt>
<dd>1.3</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCanvas()">
<h3>getCanvas</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="CoverageCanvas.html" title="class in org.apache.sis.gui.coverage">CoverageCanvas</a></span>&nbsp;<span class="element-name">getCanvas</span>()</div>
<div class="block">Returns the canvas where the image is shown.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the canvas where the image is shown.</dd>
<dt>Since:</dt>
<dd>1.2</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getView()">
<h3>getView</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">Region</span>&nbsp;<span class="element-name">getView</span>()</div>
<div class="block">Returns the region containing the grid or coverage view, band selector and any control managed by this
<code>Coverage­Explorer</code>. The <code>Region</code> subclass returned by this method is implementation dependent
and may change in any future version.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Widget.html#getView()">get­View</a></code>&nbsp;in class&nbsp;<code><a href="../Widget.html" title="class in org.apache.sis.gui">Widget</a></code></dd>
<dt>Returns:</dt>
<dd>the region to show.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#getDataView(org.apache.sis.gui.coverage.CoverageExplorer.View)"><code>get­Data­View(View)</code></a></li>
<li><a href="#getControls(org.apache.sis.gui.coverage.CoverageExplorer.View)"><code>get­Controls(View)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDataView(org.apache.sis.gui.coverage.CoverageExplorer.View)">
<h3>getDataView</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">Region</span>&nbsp;<span class="element-name">getDataView</span><wbr><span class="parameters">(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">CoverageExplorer.View</a>&nbsp;type)</span></div>
<div class="block">Returns the region containing the data visualization component, without controls other than navigation.
This is a <a href="GridView.html" title="class in org.apache.sis.gui.coverage"><code>Grid­View</code></a> or <a href="CoverageCanvas.html" title="class in org.apache.sis.gui.coverage"><code>Coverage­Canvas</code></a> together with their <a href="../map/StatusBar.html" title="class in org.apache.sis.gui.map"><code>Status­Bar</code></a>
and navigation controls for selecting the slice in a <var>n</var>-dimensional data cube.
The <code>Region</code> subclass returned by this method is implementation dependent and may change
in any future version.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - whether to obtain a <a href="GridView.html" title="class in org.apache.sis.gui.coverage"><code>Grid­View</code></a> or <a href="CoverageCanvas.html" title="class in org.apache.sis.gui.coverage"><code>Coverage­Canvas</code></a>.</dd>
<dt>Returns:</dt>
<dd>the requested view for the value of <a href="#resourceProperty"><code>resource­Property</code></a> or <a href="#coverageProperty"><code>coverage­Property</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getControls(org.apache.sis.gui.coverage.CoverageExplorer.View)">
<h3>getControls</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">TitledPane[]</span>&nbsp;<span class="element-name">getControls</span><wbr><span class="parameters">(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">CoverageExplorer.View</a>&nbsp;type)</span></div>
<div class="block">Returns the panes containing the controls, without data visualization component.
The <code>Titled­Pane</code> contents are implementation dependent and may change in any future version.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - whether to obtain controls for <a href="GridView.html" title="class in org.apache.sis.gui.coverage"><code>Grid­View</code></a> or <a href="CoverageCanvas.html" title="class in org.apache.sis.gui.coverage"><code>Coverage­Canvas</code></a>.</dd>
<dt>Returns:</dt>
<dd>the controls on specified data view.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getViewType()">
<h3>getViewType</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">CoverageExplorer.View</a></span>&nbsp;<span class="element-name">getViewType</span>()</div>
<div class="block">Returns the type of view (image or tabular data) shown in this explorer.
The default value is <a href="CoverageExplorer.View.html#TABLE"><code>Coverage­Explorer​.View​.TABLE</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the way to show coverages in this explorer.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#viewTypeProperty"><code>view­Type­Property</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setViewType(org.apache.sis.gui.coverage.CoverageExplorer.View)">
<h3>setViewType</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setViewType</span><wbr><span class="parameters">(<a href="CoverageExplorer.View.html" title="enum class in org.apache.sis.gui.coverage">CoverageExplorer.View</a>&nbsp;type)</span></div>
<div class="block">Sets the type of view to show in this explorer.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - the new way to show coverages in this explorer.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#viewTypeProperty"><code>view­Type­Property</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getResource()">
<h3>getResource</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../../storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></span>&nbsp;<span class="element-name">getResource</span>()</div>
<div class="block">Returns the source of coverages for this explorer.
This method, like all other methods in this class, shall be invoked from the JavaFX thread.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the source of coverages shown in this explorer, or <code>null</code> if none.</dd>
<dt>Since:</dt>
<dd>1.2</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#resourceProperty"><code>resource­Property</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setResource(org.apache.sis.storage.GridCoverageResource)">
<h3>setResource</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setResource</span><wbr><span class="parameters">(<a href="../../storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a>&nbsp;resource)</span></div>
<div class="block">Sets the source of coverages shown in this explorer.
This method shall be invoked from JavaFX thread and returns immediately.
The new data are loaded in a background thread and the <a href="#coverageProperty"><code>coverage­Property</code></a>
value will be updated after an undetermined amount of time.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>resource</code> - the source of data to show in this explorer, or <code>null</code> if none.</dd>
<dt>Since:</dt>
<dd>1.2</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#resourceProperty"><code>resource­Property</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCoverage()">
<h3>getCoverage</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a></span>&nbsp;<span class="element-name">getCoverage</span>()</div>
<div class="block">Returns the source of sample values for this explorer.
This method, like all other methods in this class, shall be invoked from the JavaFX thread.
Note that this value may change at any time (depending on user interaction)
if the <a href="#resourceProperty"><code>resource­Property</code></a> has a non-null value.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the coverage shown in this explorer, or <code>null</code> if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#coverageProperty"><code>coverage­Property</code></a></li>
<li><a href="CoverageCanvas.html#getCoverage()"><code>Coverage­Canvas​.get­Coverage()</code></a></li>
<li><a href="GridView.html#getImage()"><code>Grid­View​.get­Image()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCoverage(org.apache.sis.coverage.grid.GridCoverage)">
<h3>setCoverage</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setCoverage</span><wbr><span class="parameters">(<a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a>&nbsp;coverage)</span></div>
<div class="block">Sets the coverage to show in this explorer.
This method shall be invoked from JavaFX thread and returns immediately.
The new data are loaded in a background thread and will appear after an
undetermined amount of time.
<p>Invoking this method sets the <a href="#resourceProperty"><code>resource­Property</code></a> value to <code>null</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>coverage</code> - the data to show in this explorer, or <code>null</code> if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#coverageProperty"><code>coverage­Property</code></a></li>
<li><a href="CoverageCanvas.html#setCoverage(org.apache.sis.coverage.grid.GridCoverage)"><code>Coverage­Canvas​.set­Coverage(Grid­Coverage)</code></a></li>
<li><a href="GridView.html#setImage(java.awt.image.RenderedImage)"><code>Grid­View​.set­Image(Rendered­Image)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCoverage(org.apache.sis.gui.coverage.ImageRequest)">
<h3>setCoverage</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setCoverage</span><wbr><span class="parameters">(<a href="ImageRequest.html" title="class in org.apache.sis.gui.coverage">ImageRequest</a>&nbsp;source)</span></div>
<div class="block">Loads coverage in a background thread from the given source.
This method shall be invoked from JavaFX thread and returns immediately.
The grid content may appear unmodified after this method returns;
the modifications will appear after an undetermined amount of time.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>source</code> - the coverage or resource to load, or <code>null</code> if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="GridView.html#setImage(org.apache.sis.gui.coverage.ImageRequest)"><code>Grid­View​.set­Image(Image­Request)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>