Class FieldTooltipItem

    • Method Detail

      • fieldId

        public final String fieldId()

        The unique ID of the field that is targeted by the tooltip.

        Returns:
        The unique ID of the field that is targeted by the tooltip.
      • label

        public final String label()

        The label of the tooltip item.

        Returns:
        The label of the tooltip item.
      • visibility

        public final Visibility visibility()

        The visibility of the tooltip item.

        If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

        Returns:
        The visibility of the tooltip item.
        See Also:
        Visibility
      • visibilityAsString

        public final String visibilityAsString()

        The visibility of the tooltip item.

        If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

        Returns:
        The visibility of the tooltip item.
        See Also:
        Visibility
      • tooltipTarget

        public final TooltipTarget tooltipTarget()

        Determines the target of the field tooltip item in a combo chart visual.

        If the service returns an enum value that is not available in the current SDK version, tooltipTarget will return TooltipTarget.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tooltipTargetAsString().

        Returns:
        Determines the target of the field tooltip item in a combo chart visual.
        See Also:
        TooltipTarget
      • tooltipTargetAsString

        public final String tooltipTargetAsString()

        Determines the target of the field tooltip item in a combo chart visual.

        If the service returns an enum value that is not available in the current SDK version, tooltipTarget will return TooltipTarget.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tooltipTargetAsString().

        Returns:
        Determines the target of the field tooltip item in a combo chart visual.
        See Also:
        TooltipTarget
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)