SetDisplayStatus()

Summary

Changes how features in a selection set are displayed on a map.

Syntax

SetDisplayStatus(string lyr_set_name, string new_status)

Argument Contents
lyr_set_name The layer|set to be modified
new_status A string that indicates the display setting for the selection set, as shown:
Status Meaning
Active Features are highlighted using the style settings for the selection set
Inactive Features are displayed using the default style settings for the layer. Style settings for the set are ignored
Invisible Features in the set are not displayed on the map

Notes

  • If a feature in the named selection set is also contained in other selection sets, the settings for those sets also affect the appearance of the feature.

  • If lyr_set_name is null, SetDisplayStatus() changes the display status of the entire current layer.

  • If lyr_set_name has a null selection set, SetDisplayStatus() changes the display status of the entire layer.

  • Only a status of Active or Invisible is valid on the entire layer.

Examples

SetDisplayStatus("Households|High Income", "Active") // Highlight these
SetDisplayStatus("Households|Avg Income", "Inactive") // Default style
SetDisplayStatus("Households|Low Income", "Invisible") // Don't show these
SetDisplayStatus("Households|", "Invisible") // Make entire layer invisible
SetDisplayStatus(null, "Active") // Make entire current layer active

Error Codes

Error Type Meaning
Error The new_status string is invalid
NotFound The specified layer or set does not exist

See Also

Function Summary
GetDisplayStatus() Returns information on how features in a selection set are displayed on a map