Change layer label

Layer labels are useful to identify layer in the layer inspector. The layer label can be initially set at layer creation with the label argument.

l_layer_relabel(widget, layer, label)

Arguments

widget	widget path or layer object of class 'l_layer'
layer	layer id. If the widget argument is of class 'l_layer' then the layer argument is not used
label	new label of layer

Value

0 if success otherwise the function throws an error

Details

Note that the layer label is not a state of the layer itself, instead is information that is part of the layer collection (i.e. its parent widget).

See also

l_layer, l_layer_getLabel

Examples

p <- l_plot()

l <- l_layer_rectangle(p, x=0:1, y=0:1, label="A rectangle")
l_layer_getLabel(p, l)
#>        layer0 
#> "A rectangle" 

l_layer_relabel(p, l, label="A relabelled rectangle")
l_layer_getLabel(p, l)
#>                   layer0 
#> "A relabelled rectangle"