l_layer_layerVisibility: Returns logical value for whether layer is actually seen

In loon: Interactive Statistical Data Visualization

Returns logical value for whether layer is actually seen

Description

Although the visibility flag for a layer might be set to TRUE it won't be rendered as on of its ancestor group layer is set to be invisible. The l_layer_visibility returns TRUE if the layer and all its ancestor layers have their visibility flag set to true and the layer is actually rendered.

Usage

l_layer_layerVisibility(widget, layer)

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

Details

Visibile layers are rendered, invisible ones are not. If any ancestor of a layer is set to be invisible then the layer is not rendered either. The layer visibility flag can be checked with l_layer_isVisible and the actual visibility (i.e. are all the ancesters visibile too) can be checked with l_layer_layerVisibility.

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

Value

TRUE if the layer and all its ancestor layers have their visibility flag set to true and the layer is actually rendered, otherwise FALSE.

See Also

l_layer, l_layer_show, l_layer_hide, l_layer_isVisible, l_layer_groupVisibility

loon documentation built on July 9, 2023, 5:48 p.m.