uilamp

Create lamp component

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.

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.

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

Examples

Create Lamp in Figure

fig = uifigure;
lmp = uilamp(fig);

Create Lamp in Panel

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

Set and Access Lamp Properties

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

parent — Parent container

Figure object (default) | Tab object | Panel object | ButtonGroup object | GridLayout object

Parent container, specified as a Figure object created using the uifigure function or one of its child containers: Tab, Panel, ButtonGroup, or GridLayout. If you do not specify a parent container, MATLAB calls the uifigure function to create a new Figure object that serves as the parent container.

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: uilamp(Color="red") specifies that the lamp color is red.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: uilamp("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.

Color — Color of lamp

[0 1 0] (default) | RGB triplet | hexadecimal color code | 'r' | 'g' | 'b' | ...

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

RGB triplets and hexadecimal color codes are useful for specifying custom colors.

• 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].

• A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Thus, the color codes "#FF8800", "#ff8800", "#F80", and "#f80" are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color Name	Short Name	RGB Triplet	Hexadecimal Color Code	Appearance
"red"	"r"	[1 0 0]	"#FF0000"
"green"	"g"	[0 1 0]	"#00FF00"
"blue"	"b"	[0 0 1]	"#0000FF"
"cyan"	"c"	[0 1 1]	"#00FFFF"
"magenta"	"m"	[1 0 1]	"#FF00FF"
"yellow"	"y"	[1 1 0]	"#FFFF00"
"black"	"k"	[0 0 0]	"#000000"
"white"	"w"	[1 1 1]	"#FFFFFF"

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

RGB Triplet	Hexadecimal Color Code	Appearance
[0 0.4470 0.7410]	"#0072BD"
[0.8500 0.3250 0.0980]	"#D95319"
[0.9290 0.6940 0.1250]	"#EDB120"
[0.4940 0.1840 0.5560]	"#7E2F8E"
[0.4660 0.6740 0.1880]	"#77AC30"
[0.3010 0.7450 0.9330]	"#4DBEEE"
[0.6350 0.0780 0.1840]	"#A2142F"

Data Types: double | char

Position — Location and size of lamp

[100 100 20 20] (default) | [left bottom width height]

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

Element	Description
left	Distance from the inner left edge of the parent container to the outer left edge of the lamp
bottom	Distance from the inner bottom edge of the parent container to the outer bottom edge of the lamp
width	Distance between the right and left outer edges of the lamp
height	Distance 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]

Version History

Introduced in R2016a