Interface LayerVisibility

Holds effective visibility information for a specific layer in the map.

interface LayerVisibility {
    filterIssues<Keys extends VisibilityIssue = VisibilityIssue>(
        filter: VisibilityIssueFilter<Keys>,
    ): Keys[];
    hasIssues<Keys extends VisibilityIssue = VisibilityIssue>(
        filter: VisibilityIssueFilter<Keys>,
    ): boolean;
    isEffectivelyVisible: boolean;
    visibilityIssues: VisibilityIssue[];
}

Index

Properties

isEffectivelyVisible visibilityIssues

Methods

filterIssues hasIssues

Properties

`Readonly`isEffectivelyVisible

isEffectivelyVisible: boolean

Returns true if the layer is currently visible to the user.

This check takes various states into account:

Is the layer enabled at all (layer.visible)?
Are the layer's parents visible?
Is the layer visible in the current extent or zoom level?
Does the layer support the current spatial reference system or view mode?
...

`Readonly`visibilityIssues

visibilityIssues: VisibilityIssue[]

Visibility issues that prevent the layer from being visible.

This array is non-empty if isEffectivelyVisible is false.

Methods

filterIssues

filterIssues<Keys extends VisibilityIssue = VisibilityIssue>(
filter: VisibilityIssueFilter<Keys>,
): Keys[]
Filters visibility issues based on the provided filter.
Type Parameters
- Keys extends VisibilityIssue = VisibilityIssue
Parameters
- filter: VisibilityIssueFilter<Keys>
  The filter to apply.
Returns Keys[]
- Defined in api/VisibilityState.ts:110

hasIssues

hasIssues<Keys extends VisibilityIssue = VisibilityIssue>(
filter: VisibilityIssueFilter<Keys>,
): boolean
Checks if there are any visibility issues that match the provided filter.
Type Parameters
- Keys extends VisibilityIssue = VisibilityIssue
Parameters
- filter: VisibilityIssueFilter<Keys>
  The filter to apply.
Returns boolean
- Defined in api/VisibilityState.ts:115