TA Python ChameleonData API

    self.data.set_text(self.ui_output, "Clicked {} times".format(self.clickCount))

data.get_context_strs() -> str
    Get Context Strs

    Returns:
        str:

data.set_visibility(aka_name, visibility_str) -> bool
    Set the widget's visibility

    Args:
        aka_name (Name): The aka name of the widget
        visibility_str (str): The Options: "Visible"/"Collapsed"/"Hidden"/"HitTestInvisible"/"SelfHitTestInvisible"

    Returns:
        bool:

data.get_visibility(aka_name) -> str
    Get Visibility

    Args:
        aka_name (Name):

    Returns:
        str:

data.set_collapsed(aka_name, collapsed) -> None
    Set the widget's visibility collapsed or not.

    Args:
        aka_name (Name): The aka name of the widget
        collapsed (bool): Collapsed or not, True for EVisibility::Collapsed, False for EVisibility::Visible

data.set_image_data(aka_name, raw_data, width, height, channel_num=4, bgr=True) -> None
    Set SImage's Image content with Raw data.(R, G, B, A：uint8)
    note: The order of RawData is row first. Upper left corner is the first pixel, and lower right is the last. Which is different with RenderTexture2D

    Args:
        aka_name (Name): The aka name of the widget
        raw_data (Array[uint8]): The flatten raw data of image, len(RawDataIn) == Height * Width * ChannelNum
        width (int32): Width of Image.
        height (int32): Height of Image.
        channel_num (int32): Channel number of the RawData
        bgr (bool): The RawData Channel Order is Blue, Green, Red, (Alpha) or RGB(A)

data.set_image_pixels(aka_name, pixel_colors, width, height) -> None
    Set SImage's Image content with Linear Colors.

    Args:
        aka_name (Name): The aka name of the widget
        pixel_colors (Array[LinearColor]): The pixel list of image, len(PixelColors) == Height * Width
        width (int32): Width of Image.
        height (int32): Height of Image.

data.set_image_from_path(aka_name, image_file_path, brush_width=256, brush_height=256) -> None
    Set SImage's Image content from local path the resource folder of this plug-in.
    note: The base folder is the Resources folder of this plug-in

    Args:
        aka_name (Name): The aka name of the widget
        image_file_path (str): The image path in resource folder.
        brush_width (int32): Brush's width.
        brush_height (int32): Brush's height.

data.set_image_from(aka_name, image_file_path, brush_width=256, brush_height=256) -> None
    Set SImage's Image content with Linear Colors.
    note: If the ImageFilePath is a relative path, it will combined with the folder of chameleon tools's JSON path.

    Args:
        aka_name (Name): The aka name of the widget
        image_file_path (str): The image path in resource folder.
        brush_width (int32): Brush's width.
        brush_height (int32): Brush's height.

data.set_text(aka_name, text) -> None
    Set the text of widget:
    note: Supported widgets: SEditableText/SEditableTextBox/SMultiLineEditableText/SMultiLineEditableTextBox/SButton etc.

    Args:
        aka_name (Name): The aka name of the widget
        text (str): The text content.

data.get_text(aka_name) -> str or None
    Get the text of widget.
    note: Supported widgets: SEditableText/SEditableTextBox/SMultiLineEditableText/SMultiLineEditableTextBox etc.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        str or None:

        out_text (str):

data.set_text_read_only(aka_name, read_only) -> None
    Set the text of widget Read Only or not.
    note: Supported widgets: SEditableText/SEditableTextBox/SMultiLineEditableText/SMultiLineEditableTextBox etc.

    Args:
        aka_name (Name): The aka name of the widget
        read_only (bool): Is Read Only

data.set_int_value(aka_name, value) -> None
    Set integer value to widget: SSpinBox<int32>.
    note: Supported widgets: SSpinBox<int32>.

    Args:
        aka_name (Name): The aka name of the widget
        value (int32): The value to set.

data.get_int_value(aka_name) -> int32 or None
    Get integer value from widget: SSpinBox<int32>.
    note: Supported widgets: SSpinBox<int32>.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        int32 or None: The integer value of SSpinBox

        out_text (int32):

data.set_float_value(aka_name, value) -> None
    Set integer value to widget: SSpinBox<float>.
    note: Supported widgets: SSpinBox<float>.

    Args:
        aka_name (Name): The aka name of the widget
        value (float): The value to set.

data.get_float_value(aka_name) -> float or None
    Get integer value from widget: SSpinBox<int32>.
    note: Supported widgets: SSpinBox<float>.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        float or None: The float value of SSpinBox

        out_text (float):

data.set_color_and_opacity(aka_name, color) -> None
    Set widget's color and opacity.
    note: Supported widgets: SButton, SImage, STextBlock, SEditableText and other 18 SCompoundWidgetNames

    Args:
        aka_name (Name): The aka name of the widget
        color (LinearColor): The FLinear Color value.

data.set_button_color_and_opacity(aka_name, color) -> None
    Set SButton's color and opacity.
    note: Supported widgets: SButton.

    Args:
        aka_name (Name): The aka name of the widget
        color (LinearColor): The FLinear Color value.

data.get_is_checked(aka_name) -> bool
    Get the Checked state of Specified SCheckBox
    note: Supported widgets: SCheckBox.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        bool: Is Checked or not.

data.set_is_checked(aka_name, checked) -> None
    Set the Checked state of Specified SCheckBox
    note: Supported widgets: SCheckBox.

    Args:
        aka_name (Name): The aka name of the widget
        checked (bool): Is Checked or not.

data.set_combo_box_items(aka_name, str_array) -> bool
    Set SComboBox's content list.
    note: Supported widgets: SComboBox.

    Args:
        aka_name (Name): The aka name of the widget
        str_array (Array[str]): The string list for SComboBox's content.

    Returns:
        bool:

data.get_combo_box_items(aka_name) -> Array[str] or None
    Get SComboBox's content list.
    note: Supported widgets: SComboBox.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        Array[str] or None:

        out_str_array (Array[str]): The string list for SComboBox's content.

data.get_combo_box_selected_item(aka_name) -> str or None
    Get the selection of SComboBox.
    note: Supported widgets: SComboBox.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        str or None:

        out_item (str): The current selection of SComboBox.

data.set_combo_box_selected_item(aka_name, index) -> bool
    Set the selection of SComboBox.
    note: Supported widgets: SComboBox.

    Args:
        aka_name (Name): The aka name of the widget
        index (int32): The index of item for select.

    Returns:
        bool:

data.set_list_view_items(aka_name, str_array) -> None
    Set items for specified SListView.
    note: Supported widgets: SListView.

    Args:
        aka_name (Name): The aka name of the widget
        str_array (Array[str]): The list of items.

data.get_list_view_items(aka_name) -> (out_str_array=Array[str], out_item_stats=Array[int32])
    Get items from specified SListView.
    note: Supported widgets: SListView.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        tuple:

        out_str_array (Array[str]): The items source of SListView.

        out_item_stats (Array[int32]): The selection status of each items. (1 for selected)

data.set_list_view_selections(aka_name, indexes) -> None
    Set the selections of SListView.
    note: Supported widgets: SListView.

    Args:
        aka_name (Name): The aka name of the widget
        indexes (Array[int32]): The indexes of selected items.

data.set_list_view_multi_column_selections(aka_name, indexes) -> None
    Set the selections of SListView.
    note: Supported widgets: SListView.

    Args:
        aka_name (Name): The aka name of the widget
        indexes (Array[int32]): The indexes of selected items.

data.get_list_view_multi_column_items(aka_name) -> (out_str_array=Array[str], column_count=int32)
    Get the source items from specified MultiColumn SListView.
    note: Supported widgets: SListView<MultiColumn>.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        tuple:

        out_str_array (Array[str]): The flatten items list from Multi column SListView.

        column_count (int32): The number of column.

data.get_list_view_multi_column_selection(aka_name) -> Array[int32] or None
    Get List View Multi Column Selection

    Args:
        aka_name (Name):

    Returns:
        Array[int32] or None:

        out_selected_indices (Array[int32]):

data.set_list_view_multi_column_items(aka_name, flattened_str_array, column_count) -> None
    Set the source items to specified MultiColumn SListView.
    note: Supported widgets: SListView<MultiColumn>.

    Args:
        aka_name (Name): The aka name of the widget
        flattened_str_array (Array[str]): The flatten items list for Multi column SListView.
        column_count (int32): The number of column.

data.set_list_view_multi_column_line(aka_name, line_index, line_content_array, rebuild_list) -> None
    Set List View Multi Column Line

    Args:
        aka_name (Name):
        line_index (int32):
        line_content_array (Array[str]):
        rebuild_list (bool):

data.set_tree_view_items(aka_name, str_array, parent_indices) -> None
    Set the source items of SListView.
    note: Supported widgets: SListView.
    note: "TreeItemParentIndices" : [-1, 0, 0, 2, 1, 1].
    note: A
    note: |─B
    note: | └─E
    note: | └─F
    note: └─C
    note: └─D

    Args:
        aka_name (Name): The aka name of the widget
        str_array (Array[str]): Flatten list of items tree.
        parent_indices (Array[int32]): Each item's parent index

data.get_tree_view_items(aka_name) -> (out_str_array=Array[str], out_item_stats=Array[int32]) or None
    Set the source items of SListView.
    note: Supported widgets: SListView.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        tuple or None:

        out_str_array (Array[str]):

        out_item_stats (Array[int32]):

data.push_breadcrumb_string(aka_name, crumb_text, new_crumb_data) -> None
    Set item to SBreadcrumbTrail.
    note: Supported widgets: SBreadcrumbTrail.

    Args:
        aka_name (Name): The aka name of the widget
        crumb_text (str): New item for display .
        new_crumb_data (str): New item for push.

data.pop_breadcrumb_string(aka_name) -> str
    Pop a item from SBreadcrumbTrail.
    note: Supported widgets: SBreadcrumbTrail.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        str: The Popped item.

data.clear_breadcrumbs_string(aka_name, pop_all_crumbs_to_clear=False) -> None
    Clear all items from SBreadcrumbTrail.
    note: Supported widgets: SBreadcrumbTrail.

    Args:
        aka_name (Name): The aka name of the widget
        pop_all_crumbs_to_clear (bool): Pop All Crumbs or not.

data.get_breadcrumbs_count_string(aka_name) -> int32
    Get items's count from SBreadcrumbTrail.
    note: Supported widgets: SBreadcrumbTrail.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        int32: The number of crumbs.

data.set_grid_panel_column_fill(aka_name, index, value) -> None
    Set the ColumnFill value of SGridPanel.
    note: Supported widgets: SGridPanel.

    Args:
        aka_name (Name): The aka name of the widget
        index (int32): The index of column.
        value (float): The column fill value.

data.add_column(aka_name, label) -> None
    Add a column to SHeaderRow
    note: Supported widgets: SHeaderRow.

    Args:
        aka_name (Name): The aka name of the widget
        label (str): The Label of new column.

data.set_column_lable(aka_name, index, label) -> None
    Set the label of SHeaderRow
    note: Supported widgets: SHeaderRow.

    Args:
        aka_name (Name): The aka name of the widget
        index (int32): The index of HeaderRow.
        label (str): The Label of column.

data.set_progress_bar_percent(aka_name, percent) -> None
    Set the Percent of SProgressBar
    note: Supported widgets: SProgressBar.

    Args:
        aka_name (Name): The aka name of the widget
        percent (float): The Percent value.

data.set_tool_tip_text(aka_name, tool_tip_text) -> None
    Set the ToolTip Text of Widget
    note: Supported widgets: SWidget.

    Args:
        aka_name (Name): The aka name of the widget
        tool_tip_text (str): The Tool Tip Text.

data.get_scroll_box_offsets(aka_name) -> Map[str, float]
    Get the Offset, ScrollOffsetOfEnd, ViewFraction, ViewOffsetFraction values in Map.
    note: Supported widgets: SScrollBox.

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        Map[str, float]:

data.set_scroll_box_offset(aka_name, offset) -> bool
    Set the Offset Text of ScrollBox
    note: Supported widgets: SScrollBox.

    Args:
        aka_name (Name): The aka name of the widget
        offset (float): The offset value of ScrollBox

    Returns:
        bool:

data.scroll_to(aka_name, line_index=0, offset=0) -> bool
    Scroll to the Line Inex in SMultiLineEditableTextBox widget
    note: Supported widgets: SMultiLineEditableTextBox.

    Args:
        aka_name (Name): The aka name of the widget
        line_index (int32): LineIndex of TextLocation, max index is line count-1.  Scroll to end of document if LineIndex == -1
        offset (int32): Offset of TextLocation

    Returns:
        bool:

unreal.ChameleonData.request_close(tools_path="") -> bool
    Request close specified chameleon tools.

    Args:
        tools_path (str): The JSON path of Chameleon tool.

    Returns:
        bool: succeed or not

unreal.ChameleonData.launch_chameleon_tool(tools_path="") -> bool
    Launch specified chameleon tools.

    Args:
        tools_path (str): The JSON path of Chameleon tool.

    Returns:
        bool: succeed or not

data.get_is_expanded(aka_name) -> bool
    Get the Expanded state of Specified SExpandableArea
    note: Supported widgets: SExpandableArea.
    note: added in v1.0.4

    Args:
        aka_name (Name): The aka name of the widget

    Returns:
        bool: Is Expanded or not.

data.set_is_expanded(aka_name, expanded, animated=False) -> None
    Set the Expanded state of Specified SExpandableArea
    note: Supported widgets: SExpandableArea.
    note: added in v1.0.4

    Args:
        aka_name (Name): The aka name of the widget
        expanded (bool): Is Expanded or not.
        animated (bool): Expanded with animation or not.

data.set_object(aka_name, object) -> None
    Set the showing object of SDetailsView
    note: added in v1.0.9

    Args:
        aka_name (Name): The aka name of the widget
        object (Object): The Object for SDetailsView

unreal.ChameleonData.get_chameleon_window_size(tools_path, client_size_in_screen=False) -> Vector2D
    Get the window size of the Chameleon Tool
    note: added in v1.0.8

    Args:
        tools_path (str): The relative JSON path of Chameleon tool in Python folder. For instance, the gallery tool's path is "ChameleonGallery/ChameleonGallery.json"
        client_size_in_screen (bool): Get ClientSize or not

    Returns:
        Vector2D: The  size of window

unreal.ChameleonData.set_chameleon_window_size(tools_path, new_size) -> bool
    Set the window size of the Chameleon Tool
    note: added in v1.0.8

    Args:
        tools_path (str): The relative JSON path of Chameleon tool in Python folder. For instance, the gallery tool's path is "ChameleonGallery/ChameleonGallery.json"
        new_size (Vector2D): The new size of window

    Returns:
        bool: True if succeed

unreal.ChameleonData.get_chameleon_window_position(tools_path) -> Vector2D
    Get the window position of the Chameleon Tool
    note: added in v1.0.8

    Args:
        tools_path (str): The relative JSON path of Chameleon tool in Python folder.

    Returns:
        Vector2D: The position of window

unreal.ChameleonData.set_chameleon_window_position(tools_path, new_position) -> bool
    Set the window position of the Chameleon Tool
    note: added in v1.0.8

    Args:
        tools_path (str): The relative JSON path of Chameleon tool in Python folder. For instance, the gallary tool's path is "ChameleonGallery/ChameleonGallery.json"
        new_position (Vector2D):

    Returns:
        bool: True if succeed

unreal.ChameleonData.flash_chameleon_window(tools_path) -> bool
    Flash the  Chameleon Tool
    note: added in v1.0.8

    Args:
        tools_path (str): The relative JSON path of Chameleon tool in Python folder.

    Returns:
        bool: The position of window

unreal.ChameleonData.snapshot_chameleon_window(tools_path, override_window_size=[0.000000, 0.000000], image_file_path="") -> str
    Snapshot the chameleon Window, and save it to an image file. This function can save the whole UI, even it is bigger than the screen. or in a ScrollBox
    note: added in v1.0.8

    Args:
        tools_path (str): The relative JSON path of Chameleon tool in Python folder.
        override_window_size (Vector2D): Override size of the window.
        image_file_path (str): The output file path

    Returns:
        str: ImageFilePath if succeed or Empty string

unreal.ChameleonData.snapshot_sketch(override_window_size=[0.000000, 0.000000], image_file_path="") -> str
    Snapshot Sketch

    Args:
        override_window_size (Vector2D):
        image_file_path (str):

    Returns:
        str:

data.set_color(aka_name, color) -> bool
    Set color of the specified SColorBlock Widget
    note: Supported widgets: SColorBlock
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SColorBlock widget
        color (LinearColor): New Color.

    Returns:
        bool:

data.load_url(aka_name, new_url) -> None
    Load the specified URL in SWebBrowser widget.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget
        new_url (str): New URL to load.

data.get_url(aka_name) -> str
    Gets the currently loaded URL.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

    Returns:
        str: The URL, or empty string if no document is loaded.

data.load_page_from_string(aka_name, contents, dummy_url) -> None
    Load a string as data to create a web page in SWebBrowser widget.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget
        contents (str): String to load.
        dummy_url (str): Dummy URL for the page.

data.reload_page(aka_name) -> None
    Reload the current page in SWebBrowser.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

data.stop_load_page(aka_name) -> None
    Stop loading the page in SWebBrowser.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

data.get_title_text_of_page(aka_name) -> str
    Get the current title of the web page.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

    Returns:
        str:

data.is_page_loaded(aka_name) -> bool
    Whether the document finished loading.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

    Returns:
        bool:

data.is_page_loading(aka_name) -> bool
    Whether the document is currently being loaded.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

    Returns:
        bool:

data.can_go_back(aka_name) -> bool
    Returns true if the browser can navigate backwards.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

    Returns:
        bool:

data.go_back(aka_name) -> None
    Navigate backwards.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

data.can_go_forward(aka_name) -> bool
    Returns true if the browser can navigate forwards.
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

    Returns:
        bool:

data.go_forward(aka_name) -> None
    Navigate forwards..
    note: Supported widgets: SWebBrowser only
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget

data.bind_uobject_to_browser(aka_name, name, object, is_permanent=True) -> None
    Expose a UObject instance to the browser runtime. Properties and Functions will be accessible from JavaScript side.
    note: Supported widgets: SWebBrowser only. When I get the property value from the java script Promise object, the values are always empty, it's weird.
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget
        name (str): The name of the object.The object will show up as window.ue.{Name} on the javascript side.Note: All object names, function names, and property names will be converted to lower case when bound on the javascript side.If there is an existing object of the same name, this object will replace it.If bIsPermanent is false and there is an existing permanent binding, the permanent binding will be restored when the temporary one is removed.
        object (Object): The object instance.
        is_permanent (bool): If true, the object will be visible to all pages loaded through this browser widget, otherwise, it will be deleted when navigating away from the current page.Non - permanent bindings should be registered from inside an OnLoadStarted event handler in order to be available before JS code starts loading.

data.unbind_uobject_to_browser(aka_name, name, object, is_permanent=True) -> None
    Remove an existing script binding registered by BindUObject. Properties and Functions will be accessible from JavaScript side.
    note: Supported widgets: SWebBrowser only.
    note: added in v1.0.10

    Args:
        aka_name (Name): The aka name of the SWebBrowser widget
        name (str): The name of the object to remove.
        object (Object): The object will only be removed if it is the same object as the one passed in.
        is_permanent (bool): Must match the bIsPermanent argument passed to BindUObject.