Main Content


Apply mask image to component

Since R2023b



    setMaskImage(arch,Name=Value) applies mask image to the architecture arch of a Component block or Variant Component block in System Composer™.


    collapse all

    Create a model with a component called Component.

    model = systemcomposer.createModel("archModel");
    arch = get(model,"Architecture");
    comp = addComponent(arch,"Component");

    Apply a mask image to the component found in the Icons folder as image.png, that appears transparent, and that is stored within the model.


    Input Arguments

    collapse all

    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")

    Relative path of mask image, specified as a character vector or string.

    Example: comp.Architecture.setMaskImage(FilePath="Icons/image.png")

    Data Types: char | string

    Transparency of mask image, specified by 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

    Whether image file should be stored natively in the model, specified by 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

    collapse all


    TermDefinitionApplicationMore Information

    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.


    The root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports surrounding 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.

    Compose Architectures Visually


    A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors.

    Perform operations on a model:

    • Extract root-level architecture.

    • Apply profiles.

    • Attach interface data dictionaries.

    • Generate instances from model architecture.

    A System Composer model is stored as an SLX file.

    Create Architecture Model with Interfaces and Requirement Links

    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:

    Compose Architectures Visually


    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.

    • Component ports are interaction points on the component to other components.

    • Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model. The root architecture has a boundary defined by its ports.

    Compose Architectures Visually


    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.

    Compose Architectures Visually

    TermDefinitionApplicationMore Information

    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