Image Class — NXOpen Python API Reference 12.0.0 documentation

# Image Class

class `NXOpen.Display.``Image`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Display.Image`

  This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.

  To create a new instance of this class, use `NXOpen.ViewCollection.CreateImage()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ImagePreviewToggle | Returns or sets the image preview toggle
PatternRepeatFactor | Returns or sets the pattern repeat factor - the number of times the image repeats; non integer patternRepeatFactor numbers result in partial repeats.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ImageFileSelect | Gets an image file using file selection.
ImagePaletteSelect | Gets an image file from the image palette.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## ImagePreviewToggle

`Image.``ImagePreviewToggle`

  Returns or sets the image preview toggle

  `-------------------------------------`

  Getter Method

  Signature `ImagePreviewToggle`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ImagePreviewToggle`

  Parameters: | imagePreviewToggle (bool) –

  New in version NX6.0.0.

  License requirements: None.

## PatternRepeatFactor

`Image.``PatternRepeatFactor`

  Returns or sets the pattern repeat factor - the number of times the image repeats; non integer patternRepeatFactor numbers result in partial repeats.

  `-------------------------------------`

  Getter Method

  Signature `PatternRepeatFactor`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PatternRepeatFactor`

  Parameters: | patternRepeatFactor (float) –

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## ImageFileSelect

`Image.``ImageFileSelect`

  Gets an image file using file selection.

  Signature `ImageFileSelect()`

  New in version NX5.0.0.

  License requirements: None.

## ImagePaletteSelect

`Image.``ImagePaletteSelect`

  Gets an image file from the image palette.

  Signature `ImagePaletteSelect()`

  New in version NX5.0.0.

  License requirements: None.

## Validate

`Image.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.