This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

uilamp

(App Designer) Create lamp component

Use only with App Designer or figures created with the uifigure function. Apps created with GUIDE or the figure function do not support lamp components.

Syntax

lmp = uilamp
lmp = uilamp(parent)
lmp = uilamp(___,Name,Value)

Description

lmp = uilamp creates a lamp in a new figure window and returns the Lamp object. MATLAB® calls the uifigure function to create the figure.

example

lmp = uilamp(parent) creates the lamp in the specified parent container. The parent can be a Figure created using the uifigure function, or one of its child containers.

example

lmp = uilamp(___,Name,Value) specifies Lamp properties using one or more Name,Value pair arguments. Use this option with any of the input argument combinations in the previous syntaxes.

Examples

collapse all

fig = uifigure;
lmp = uilamp(fig);

fig = uifigure;
pnl= uipanel(fig);
lmp = uilamp(pnl);

Create a default lamp.

fig = uifigure;
lmp = uilamp(fig);

Determine the current color of the lamp.

color = lmp.Color
color =

     0     1     0

MATLAB returns the RGB value for green.

Change the lamp color to red by setting the Color property to the long name, 'red'.

lmp.Color = 'red';

Change the lamp color to blue by setting the Color property to the RGB triplet for blue.

lmp.Color = [0 0 1];

Input Arguments

collapse all

Parent container, specified as a Figure created using the uifigure function, or one of its child containers: Tab, Panel, ButtonGroup, or GridLayout.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Color','red' specifies that the lamp color is red.

The properties listed here are a subset of the available properties. For the full list, see Lamp Properties.

Color of the lamp, specified as an RGB triplet, or one of the color options listed in the table.

An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7]. Alternatively, you can specify some common colors by name. This table lists the long and short color name options and the equivalent RGB triplet values.

OptionDescriptionEquivalent RGB Triplet
'red' or 'r'Red[1 0 0]
'green' or 'g'Green[0 1 0]
'blue' or 'b'Blue[0 0 1]
'yellow' or 'y'Yellow[1 1 0]
'magenta' or 'm'Magenta[1 0 1]
'cyan' or 'c'Cyan[0 1 1]
'white' or 'w'White[1 1 1]
'black' or 'k'Black[0 0 0]

Data Types: double | char

Location and size of the lamp, specified as the vector [left bottom width height]. This table describes each element in the vector.

ElementDescription
leftDistance from the inner left edge of the parent container to the outer left edge of the lamp
bottomDistance from the inner bottom edge of the parent container to the outer bottom edge of the lamp
widthDistance between the right and left outer edges of the lamp
heightDistance between the top and bottom outer edges of the lamp

All measurements are in pixel units.

Due to aspect ratio constraints, you cannot change the lamp height and width independently of one another.

The Position values are relative to the drawable area of the parent container. The drawable area is the area inside the borders of the container and does not include the area occupied by decorations such as a menu bar or title.

Example: [100 200 20 20]

See Also

Functions

Properties

Introduced in R2016a