Interface PropertiesSidebarConfiguration


  • public interface PropertiesSidebarConfiguration
    Configuration to associate part or all of the widget with the Properties Sidebar.
    Currently, this sidebar only supports Work Items.
    Since:
    3.17.3
    • Method Detail

      • containerId

        @NotNull
        PropertiesSidebarConfiguration containerId​(@NotNull
                                                   java.lang.String id)
        Sets the ID of the configured container. Will be used for the identification of elements inside the widget section.
      • fieldIds

        @NotNull
        PropertiesSidebarConfiguration fieldIds​(@NotNull
                                                java.util.List<java.lang.String> fieldIds)
        Sets the list of fields that will be shown in the Properties Sidebar. This list will be the same for all items across the widget (or widget section).
        Parameters:
        fieldIds - to be shown in the sidebar.
      • fieldsConfiguration

        @NotNull
        PropertiesSidebarConfiguration fieldsConfiguration​(@NotNull
                                                           java.util.Map<java.lang.String,​java.util.List<java.lang.String>> fieldsConfiguration)
        This method allows you to set up a configuration to display different fields in the sidebar for different items.
        The map keys are values for the items groups. Each item can be marked as belonging to a certain group, by using PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration.fieldsConfigurationKey(String)
        The values are lists of field IDs that should be displayed in the sidebar.
        For example: Given the fieldConfiguration parameter as the map {"card":["severity", "status"], "swimlane":["author", "status"]"}, for all the Work Items rendered with PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration#fieldsConfigurationKey("card"), the fields shown in the sidebar will be "severity" and "status" and for all the Work Items rendered with PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration#fieldsConfigurationKey("swimlane") the fields shown in the sidebar will be "author" and "status"
        Parameters:
        fieldsConfiguration - The configuration for deciding which fields are displayed in the sidebar, based on the item itself.