API Quick Summary

API

class nion.typeshed.API_1_0.API

Methods
  • create_calibration

  • create_data_and_metadata

  • create_data_and_metadata_from_data

  • create_data_and_metadata_io_handler

  • create_data_descriptor

  • create_hardware_source

  • create_menu_item

  • create_panel

  • get_all_hardware_source_ids

  • get_all_instrument_ids

  • get_hardware_source_by_id

  • get_instrument_by_id

  • queue_task

Properties
  • application

  • library

Application

class nion.typeshed.API_1_0.Application

Properties
  • document_controllers

  • document_windows

  • library

DataGroup

class nion.typeshed.API_1_0.DataGroup

Methods
  • add_data_item

Properties
  • uuid

DataItem

class nion.typeshed.API_1_0.DataItem

Methods
  • add_channel_region

  • add_ellipse_region

  • add_interval_region

  • add_line_region

  • add_point_region

  • add_rectangle_region

  • delete_metadata_value

  • get_metadata_value

  • has_metadata_value

  • mask_xdata

  • remove_region

  • set_data

  • set_data_and_metadata

  • set_dimensional_calibrations

  • set_intensity_calibration

  • set_metadata

  • set_metadata_value

Properties
  • created

  • data

  • data_and_metadata

  • dimensional_calibrations

  • display

  • display_xdata

  • graphics

  • intensity_calibration

  • metadata

  • modified

  • regions

  • title

  • uuid

  • xdata

Display

class nion.typeshed.API_1_0.Display

Methods
  • get_graphic_by_id

Properties
  • data_item

  • data_items

  • display_type

  • graphics

  • selected_graphics

  • uuid

DisplayPanel

class nion.typeshed.API_1_0.DisplayPanel

Methods
  • set_data_item

Properties
  • data_item

DocumentWindow

class nion.typeshed.API_1_0.DocumentWindow

Methods
  • add_data

  • create_data_item_from_data

  • create_data_item_from_data_and_metadata

  • display_data_item

  • get_display_panel_by_id

  • get_or_create_data_group

  • queue_task

  • show_confirmation_message_box

  • show_get_string_message_box

  • show_modeless_dialog

Properties
  • all_display_panels

  • library

  • target_data_item

  • target_display

Graphic

class nion.typeshed.API_1_0.Graphic

Methods
  • get_property

  • mask_xdata_with_shape

  • set_property

Properties
  • angle

  • bounds

  • center

  • end

  • graphic_id

  • graphic_type

  • interval

  • label

  • position

  • region

  • size

  • start

  • type

  • uuid

  • vector

HardwareSource

class nion.typeshed.API_1_0.HardwareSource

Methods
  • abort_playing

  • abort_recording

  • close

  • create_record_task

  • create_view_task

  • get_default_frame_parameters

  • get_frame_parameters

  • get_frame_parameters_for_profile_by_index

  • get_property_as_bool

  • get_property_as_float

  • get_property_as_float_point

  • get_property_as_int

  • get_property_as_str

  • grab_next_to_finish

  • grab_next_to_start

  • record

  • set_frame_parameters

  • set_frame_parameters_for_profile_by_index

  • set_property_as_bool

  • set_property_as_float

  • set_property_as_float_point

  • set_property_as_int

  • set_property_as_str

  • start_playing

  • start_recording

  • stop_playing

Properties
  • is_playing

  • is_recording

  • profile_index

Instrument

class nion.typeshed.API_1_0.Instrument

Methods
  • close

  • get_control_output

  • get_control_state

  • get_property_as_bool

  • get_property_as_float

  • get_property_as_float_point

  • get_property_as_int

  • get_property_as_str

  • set_control_output

  • set_property_as_bool

  • set_property_as_float

  • set_property_as_float_point

  • set_property_as_int

  • set_property_as_str

Library

class nion.typeshed.API_1_0.Library

Methods
  • copy_data_item

  • create_data_item

  • create_data_item_from_data

  • create_data_item_from_data_and_metadata

  • data_ref_for_data_item

  • delete_library_value

  • get_data_item_by_uuid

  • get_data_item_for_hardware_source

  • get_data_item_for_reference_key

  • get_dependent_data_items

  • get_graphic_by_uuid

  • get_library_value

  • get_or_create_data_group

  • get_source_data_items

  • has_library_value

  • set_library_value

  • snapshot_data_item

Properties
  • data_item_count

  • data_items

  • display_items

  • uuid