Action
    Preparing search index...

    Class InsightImage

    Contains settings for the image or icon to show for an insight.

    2.5

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    ActionIcon Binary CustomIcon InsightIcon LivePreview None

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1 | null

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • Gets the setting to show the icon of the action script or action mod executed by this insight.

      Returns InsightImage

      The icon setting.

      2.5

    • Gets the setting to show a binary preview image loaded from a file path in an action mod.

      Parameters

      • filePath: string | String

        The relative file path within the mod (e.g., "images/preview.png").

      Returns InsightImage

      The icon setting.

      2.5

    • Gets the setting to show a custom SVG icon.

      Parameters

      • svgIcon: string | String

        The SVG icon markup.

      Returns InsightImage

      The icon setting.

      2.5

    • Gets the setting to show the icon of the insight script or the current agent mod.

      Returns InsightImage

      The icon setting.

      2.5

    • Gets the setting to show a live preview of the insight result. This will render the first new page or visual. Note that this may impact the overall performance and freeze the UI temporarily, depending on the complexity of the insight.

      Returns InsightImage

      The icon setting.

      2.5

    • Gets the setting to show a live preview of a page as the insight result. Note that this may impact the overall performance and freeze the UI temporarily, depending on the complexity of the insight.

      Parameters

      • previewPage: Page

        The page to render a preview for.

      Returns InsightImage

      The icon setting.

      2.5

    • Gets the setting to show a live preview of a visual as the insight result. Note that this may impact the overall performance and freeze the UI temporarily, depending on the complexity of the insight.

      Parameters

      • previewVisual: Visual

        The visual to render a preview for.

      Returns InsightImage

      The icon setting.

      2.5

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability