Interface FrameworkCommands

Callable

• __call(commandName: "ActivateView"): TypedCommand<function>
• __call(commandName: "DeactivateView"): TypedCommand<function>
• __call(commandName: "ToggleView"): TypedCommand<function>
• __call(commandName: "DestroyView"): TypedCommand<function>
• __call(commandName: "CloseModalRegion"): TypedCommand<function>
• __call(commandName: "OpenWebPage"): TypedCommand<function>
• __call(commandName: string): TypedCommand<any>

• Activates a view by its ID.

  docs-gcx-command

  geocortex.framework

  name

  ActivateView

  introduced

  1.0

  gcx-command-category

  Region and View

  Parameters

  • commandName: "ActivateView"

  Returns TypedCommand<function>

• Deactivates a view by its ID.

  docs-gcx-command

  geocortex.framework

  name

  DeactivateView

  introduced

  1.0

  gcx-command-category

  Region and View

  Parameters

  • commandName: "DeactivateView"

  Returns TypedCommand<function>

• Activates or deactivates a view based on its current state.

  docs-gcx-command

  geocortex.framework

  name

  ToggleView

  introduced

  1.0

  gcx-command-category

  Region and View

  Parameters

  • commandName: "ToggleView"

  Returns TypedCommand<function>

• Destroys a view, wiping out its bindings and DOM elements.

  docs-gcx-command

  geocortex.framework

  name

  DestroyView

  introduced

  1.0

  gcx-command-category

  Region and View

  Parameters

  • commandName: "DestroyView"

  Returns TypedCommand<function>

• Closes the application's modal region, if there is one. The modal region is a singleton region backed by the PopupModalRegionAdapter type.

  docs-gcx-command

  geocortex.framework

  name

  CloseModalRegion

  introduced

  1.0

  gcx-command-category

  Region and View

  Parameters

  • commandName: "CloseModalRegion"

  Returns TypedCommand<function>

• Opens a web page in another tab/window.

  docs-gcx-command

  geocortex.framework

  name

  OpenWebPage

  introduced

  1.0

  gcx-command-category

  Region and View

  Parameters

  • commandName: "OpenWebPage"

  Returns TypedCommand<function>

• Commands exposed by the framework.

  Parameters

  • commandName: string

  Returns TypedCommand<any>