setMaskImage
Description
setMaskImage(
applies mask image to the architecture arch
,Name=Value
)arch
of a Component
block or Variant
Component block in System Composer™.
Examples
Apply Mask Image to Component
Create a model with a component called Component
.
model = systemcomposer.createModel("archModel"); systemcomposer.openModel("archModel"); arch = get(model,"Architecture"); comp = addComponent(arch,"Component");
Apply a mask image to the component in the Icons
folder as
image.png
that appears transparent and is stored within the
model.
comp.Architecture.setMaskImage(FilePath="Icons/image.png",... IconTransparency="transparent",... IsInternalImage="on")
Input Arguments
arch
— Architecture
architecture object
Architecture, specified as a systemcomposer.arch.Architecture
object.
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Example: comp.Architecture.setMaskImage(FilePath="Icons/image.png",IconTransparency="transparent",IsInternalImage="on")
FilePath
— Relative path of mask image
character vector | string
Relative path of mask image, specified as a character vector or string.
Example: comp.Architecture.setMaskImage(FilePath="Icons/image.png")
Data Types: char
| string
IconTransparency
— Transparency of mask image
"opaque"
| "transparent"
| "opaque-with-ports"
Transparency of mask image, specified as one of these options:
"opaque"
— No transparency"transparent"
— Transparent parts of image in PNG format are shown as fully transparent"opaque-with-ports"
— No transparency with ports shown
Example: comp.Architecture.setMaskImage(IconTransparency="transparent")
Data Types: char
| string
IsInternalImage
— Option to store image file natively in the model
"on"
| "off"
Option to store image file natively in the model, specified as one of these options:
"on"
— Image file is stored natively in the model"off"
— Image file is available on the path from which it is selected and not saved in the model
Example: comp.Architecture.setMaskImage(IsInternalImage="on")
Data Types: char
| string
More About
Definitions
Term | Definition | Application | More Information |
---|---|---|---|
architecture | A System Composer architecture represents a system of components and how they interface with each other structurally and behaviorally. |
Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor. | |
root | A root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports that surround the system of interest. | The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary. | |
model | A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors. |
Perform operations on a model:
A System Composer model is stored as an SLX file. | Create Architecture Model with Interfaces and Requirement Links |
component | A component is a replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architectural element, such as a function, another system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction. | Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts. Transfer information between components with:
| |
port | A port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems. |
| |
connector | Connectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures. | A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact. |
Term | Definition | Application | More Information |
---|---|---|---|
variant | A variant is one of many structural or behavioral choices in a variant component. | Use variants to quickly swap different architectural designs for a component while performing analysis. | Create Variants |
variant control | A variant control is a string that controls the active variant choice. | Set the variant control programmatically to control which variant is active. | Set Variant Control Condition |
Version History
Introduced in R2023b
See Also
Functions
iterate
|getQualifiedName
|lookup
|systemcomposer.createModel
|systemcomposer.loadModel
|systemcomposer.openModel
|open
|save
|close
|createArchitectureModel
|createArchitectureSubsystem
|linkToModel
|inlineComponent
|addComponent
|addPort
|getPort
|setName
|connect
|destroy
Objects
systemcomposer.arch.Element
|systemcomposer.arch.Architecture
|systemcomposer.arch.Component
|systemcomposer.arch.ComponentPort
|systemcomposer.arch.ArchitecturePort
|systemcomposer.arch.Connector
|systemcomposer.arch.PhysicalConnector
Blocks
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)