Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "geocortex/essentials/utilities/GraphicsLayerUtilities"

Index

Variables

excludeFromExportMapTaskName

excludeFromExportMapTaskName: "ExportMapTask" = "ExportMapTask"

Built in names of components which modules can have their graphics layers be excluded from. Third party modules may pass in additional components as strings.

Functions

addToGraphicsLayerIdsToExclude

  • addToGraphicsLayerIdsToExclude(excludeFromList: string[], graphicsLayerId: string): void
  • Allows both GVH and 3rd party modules to add their own graphics layer IDs to the list of layers be excluded.

    Parameters

    • excludeFromList: string[]
    • graphicsLayerId: string

    Returns void

getGraphicsLayerIdsToExclude

  • getGraphicsLayerIdsToExclude(excludeFromList: string[]): string[]
  • Gets the list of graphics layer IDs to be excluded from a given task. Most tasks were set up to filter out graphics layer IDs based on another list of graphics layer IDs, this provides that other list.

    Parameters

    • excludeFromList: string[]

      The list of activities to exclude, can be found in ExcludeFromEnum

    Returns string[]

removeFromGraphicsLayerIdsToExclude

  • removeFromGraphicsLayerIdsToExclude(excludeFromList: string[], graphicsLayerId: string): void
  • Allows both GVH and 3rd party modules to remove their own graphics layers IDs to the list of layers be excluded.

    Parameters

    • excludeFromList: string[]
    • graphicsLayerId: string

    Returns void