Package com.inductiveautomation.ignition.gateway.model.entity

Interface NavigationComponent

public interface NavigationComponent
Data component that can be attached to an Entity to provide navigational information for the web-ui. Useful for entities which are represented in the web-ui, to provide users a link to navigate to the entity's page.

  • Field Details

    • SECTION_OVERVIEW_TAG

      static final String SECTION_OVERVIEW_TAG
      Well known UI tag for entities that should be included in the section overview web ui
      See Also:

    • DIAGNOSTICS_OVERVIEW_TAG

      static final String DIAGNOSTICS_OVERVIEW_TAG
      Well known UI tag for entities that should be included in the diagnostics overview web ui
      See Also:

  • Method Details

    • getSection

      String getSection()
      The navigation section this entity belongs to.
      See Also:

    • getUiTags

      Set<String> getUiTags()
      A collection of string-based "tags" that provide signals to the web-ui about this entity.

      Use well known tag "section-overview" to include this entity in the section overview web ui.

    • getActions

      List<NavigationComponent.NavigationAction> getActions()