|
ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
|
|
ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
This is the abstract class for generating instances of objects that contain the specifications of various types of tile figures.
More...
Public Member Functions | |
| function | Tile (in template, in varargin) |
| Generate and return an object of class pm.vis.Tile. More... | |
| function | reset (in self, in varargin) |
| Reset the properties of the tile to the original default settings. More... | |
| function | make (in self, in varargin) |
| Configure the tile settings and specifications, make the tile, and return nothing. More... | |
| function | premake (in self, in varargin) |
| Configure the tile settings and specifications and return nothing. More... | |
Data Fields | |
| Property | template |
| Property | tileshape |
This is the abstract class for generating instances of objects that contain the specifications of various types of tile figures.
This is a generic class for generating figures containing multiple subplots (axes) of the same class.
Final Remarks ⛓
If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.
This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.
| function Tile::Tile | ( | in | template, |
| in | varargin | ||
| ) |
Generate and return an object of class pm.vis.Tile.
This class is not meant to be used directly by the end users.
Instead, use the subclasses of this abstract class for visualizations.
See the list of class attributes and those of the superclass pm.vis.Tiling.
| [in] | template | : The input scalar object of superclass pm.vis.Subplot. It serves as the template based upon which all subplots are constructed. |
| [in] | varargin | : Any property, value pair of the parent object.If the property is a struct(), then its value must be given as a cell array, with consecutive elements representing the struct property-name, property-value pairs.Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the make() method. |
self : The output scalar object of class pm.vis.Tile.
Possible calling interfaces ⛓
varargin can also contain the components of the template component of the parent object.
Final Remarks ⛓
If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.
This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.
| function Tile::make | ( | in | self, |
| in | varargin | ||
| ) |
Configure the tile settings and specifications, make the tile, and return nothing.
In making the figure, this method we call the make() methods of each of the subplot objects stored in the subplot component.
| [in] | self | : The implicitly-passed input argument representing the parent object of the method. |
| [in] | varargin | : Any property, value pair of the parent object.If the property is a struct(), then its value must be given as a cell array, with consecutive elements representing the struct property-name, property-value pairs.Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the make() method. |
Possible calling interfaces ⛓
varargin can also contain the components of the subplot component of the parent object.
Example usage ⛓
t = pm.vis.Tile(pm.vis.SubplotLine()); t.make()
| function Tile::premake | ( | in | self, |
| in | varargin | ||
| ) |
Configure the tile settings and specifications and return nothing.
| [in] | self | : The implicitly-passed input argument representing the parent object of the method. |
| [in] | varargin | : Any property, value pair of the parent object.If the property is a struct(), then its value must be given as a cell array, with consecutive elements representing the struct property-name, property-value pairs.Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the premake() method. |
Possible calling interfaces ⛓
Example usage ⛓
f = pm.vis.Tile(pm.vis.Line());
f.premake("figure", {"color", "none"})
| function Tile::reset | ( | in | self, |
| in | varargin | ||
| ) |
Reset the properties of the tile to the original default settings.
Use this method when you change many attributes of the tile and you want to clean up and go back to the default settings.
| [in] | self | : The implicitly-passed input argument representing the parent object of the method. |
| [in] | varargin | : Any property, value pair of the parent object.If the property is a struct(), then its value must be given as a cell array, with consecutive elements representing the struct property-name, property-value pairs.Note that all of these property-value pairs can be also directly set via the parent object attributes, before calling the make() method. |
Possible calling interfaces ⛓
varargin can also contain the components of the subplot component of the parent object.
Final Remarks ⛓
If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.
This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.
| Property Tile::template |
template
The scalar object of superclass pm.vis.Subplot representing the template of the set of subplots to display.
| Property Tile::tileshape |
1.9.3