Skip to main content
Ctrl+K
PyEnSight - Home
  • Getting started
  • User guide
  • API reference
  • Examples
  • Contribute
Ctrl+K
  • GitHub
Ctrl+K
  • Getting started
  • User guide
  • API reference
  • Examples
  • Contribute
  • GitHub

Section Navigation

  • Native API reference
    • ansys.api.pyensight.ensight_api
    • anim
    • anim_flipbook
    • anim_keyframe
    • anim_quick
    • anim_recorders
    • anim_screens
    • anim_traces
    • annot_backgr
    • annot_entlbl
    • annotation
    • arrow
    • auxgeom
    • boundarylayer
    • case
    • clip
    • collab
    • command
    • connect
    • context_restore
    • contour
    • curve
    • data
    • data_partbuild
    • define
    • devsrf
    • dial
    • dpart
    • elevsurf
    • ensight
    • enums
    • extrude
    • file
    • filterpart
    • format
    • frame
    • function
    • gauge
    • help
    • isos
    • legend
    • lightsource
    • line
    • logo
    • material
    • message_window
    • model
    • nplot
    • nvc
    • objs
    • part
    • plot
    • pointpart
    • prefs
    • profile
    • ptrace
    • ptrace_emitr
    • query_ent_var
    • query_interact
      • action
      • coord_report_by_x
      • coord_report_by_y
      • coord_report_by_z
      • create
      • display_expansion_factor
      • display_id
      • display_node_number
      • label_always_on_top
      • label_decimal_places
      • label_format
      • label_rgb
      • label_visible
      • marker_rgb
      • marker_size
      • marker_size_normalized
      • marker_visible
      • number_displayed
      • output
      • query
      • query_attributes
      • query_count
      • request_method
      • request_mode
      • save
      • search
      • select_all
      • select_begin
      • select_default
      • select_varname_begin
      • select_varname_default
      • select_varname_end
      • type
      • update_probe
      • variable
      • vector_report_by_mag
      • vector_report_by_x
      • vector_report_by_y
      • vector_report_by_z
    • savegeom
    • scene
    • sepattach
    • set_tdata
    • set_visenv
    • shape
    • shell
    • shock
    • show_info
    • solution_time
    • species
    • subset
    • tensor
    • text
    • texture
    • tools
    • user
    • varextcfd
    • variables
    • vctarrow
    • view
    • view_transf
    • viewport
    • viewport_axis
    • viewport_bounds
    • views
    • vof
    • vortexcore
  • Object API reference
  • Calculator functions
  • REST API
  • LibUserd API reference
  • EnsContext
  • LocalLauncher
  • DockerLauncher
  • Renderable
  • Session
  • Export
  • Parts
  • Query
  • Support
  • Views
  • Variables
  • Omniverse
  • Readers
  • DVS
  • API reference
  • Native API reference
  • query_interact
  • search

search#

query_interact.search(p0: str) → int#

Sets the search mode for surface pick or cursor queries.

Args:
p0:

‘search_mode’

  • may be any of the following values:

  • exact

  • closest_node

Examples:
#WARNING: the following line failed to translate because the function could not be found in the ensight python module
#   Actual error: module 'ensight' has no attribute 'variable'
ensight.sendmesg(r"variable: activate pressure")
ensight.query_interact.select_varname_begin("pressure")
ensight.query_interact.query("cursor")
ensight.query_interact.search("closest_node")
ensight.query_interact.create(12.0,15.1,10.3)
Returns:

zero on success, non-zero on error

On this page
  • query_interact.search()
Show Source

© Copyright (c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited..

Created using Sphinx 8.1.3.

Built with the Ansys Sphinx Theme 1.1.1.
Last updated on