SpecifyVector Class — NXOpen Python API Reference 12.0.0 documentation

# SpecifyVector Class

class `NXOpen.BlockStyler.``SpecifyVector`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents Specify Vector block

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AutomaticProgression | Returns or sets the AutomaticProgression
BalloonTooltipImage | Returns or sets the BalloonTooltipImage
BalloonTooltipLayoutAsString | Returns or sets the BalloonTooltipLayout as string
BalloonTooltipText | Returns or sets the BalloonTooltipText
CreateInterpartLink | Returns or sets the CreateInterpartLink
DoubleSide | Returns or sets the DoubleSide
Enable | Returns or sets the Enable.
EnableFacetSelection | Returns or sets the EnableFacetSelection
EnableReverseDirection | Returns or sets the EnableReverseDirection
Expanded | Returns or sets the Expanded
Group | Returns or sets the Group
InterpartSelectionAsString | Returns or sets the InterpartSelection as string
Is2DMode | Returns or sets the Is2DMode.
Label | Returns or sets the Label
LabelString | Returns or sets the LabelString
Name | Returns the name of the block or BlockID
Point | Returns or sets the Point
Show | Returns or sets the Visibility of block.
ShowShortcuts | Returns or sets the ShowShortcuts
SnapPointTypesOnByDefault | Returns or sets the SnapPointTypesOnByDefault
StepStatusAsString | Returns or sets the StepStatus as string
Tag | Returns the Tag for this object.
Type | Returns the type of block
Vector | Returns or sets the Vector

# Methods

Method | Description
--- | ---
Focus | Focuses on the block.
GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout members
GetInterpartSelectionMembers | Gets the InterpartSelection members
GetProperties | Returns the properties of the block
GetSelectedObjects | Gets the SelectedObjects
GetStepStatusMembers | Gets the StepStatus
SetSelectedObjects | Sets the SelectedObjects

# Property Detail

## AutomaticProgression

`SpecifyVector.``AutomaticProgression`

  Returns or sets the AutomaticProgression

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

  Getter Method

  Signature `AutomaticProgression`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AutomaticProgression`

  Parameters: | automaticProgression (bool) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipImage

`SpecifyVector.``BalloonTooltipImage`

  Returns or sets the BalloonTooltipImage

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

  Getter Method

  Signature `BalloonTooltipImage`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BalloonTooltipImage`

  Parameters: | imageString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipLayoutAsString

`SpecifyVector.``BalloonTooltipLayoutAsString`

  Returns or sets the BalloonTooltipLayout as string

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

  Getter Method

  Signature `BalloonTooltipLayoutAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BalloonTooltipLayoutAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipText

`SpecifyVector.``BalloonTooltipText`

  Returns or sets the BalloonTooltipText

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

  Getter Method

  Signature `BalloonTooltipText`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `BalloonTooltipText`

  Parameters: | balloonTooltipText (str) –

  New in version NX8.5.0.

  License requirements: None.

## CreateInterpartLink

`SpecifyVector.``CreateInterpartLink`

  Returns or sets the CreateInterpartLink

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

  Getter Method

  Signature `CreateInterpartLink`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateInterpartLink`

  Parameters: | createLink (bool) –

  New in version NX8.5.0.

  License requirements: None.

## DoubleSide

`SpecifyVector.``DoubleSide`

  Returns or sets the DoubleSide

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

  Getter Method

  Signature `DoubleSide`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DoubleSide`

  Parameters: | doubleSide (bool) –

  New in version NX8.5.0.

  License requirements: None.

## EnableFacetSelection

`SpecifyVector.``EnableFacetSelection`

  Returns or sets the EnableFacetSelection

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

  Getter Method

  Signature `EnableFacetSelection`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `EnableFacetSelection`

  Parameters: | enableSelection (bool) –

  New in version NX8.5.0.

  License requirements: None.

## EnableReverseDirection

`SpecifyVector.``EnableReverseDirection`

  Returns or sets the EnableReverseDirection

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

  Getter Method

  Signature `EnableReverseDirection`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `EnableReverseDirection`

  Parameters: | enableReverse (bool) –

  New in version NX8.5.0.

  License requirements: None.

## InterpartSelectionAsString

`SpecifyVector.``InterpartSelectionAsString`

  Returns or sets the InterpartSelection as string

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

  Getter Method

  Signature `InterpartSelectionAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `InterpartSelectionAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## Is2DMode

`SpecifyVector.``Is2DMode`

  Returns or sets the Is2DMode.

  If true, vector is created in 2D space.

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

  Getter Method

  Signature `Is2DMode`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Is2DMode`

  Parameters: | is2DMode (bool) –

  New in version NX8.5.0.

  License requirements: None.

## LabelString

`SpecifyVector.``LabelString`

  Returns or sets the LabelString

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

  Getter Method

  Signature `LabelString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelString`

  Parameters: | labelString (str) –

  New in version NX8.5.0.

  License requirements: None.

## Point

`SpecifyVector.``Point`

  Returns or sets the Point

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

  Getter Method

  Signature `Point`

  Returns: |
  Return type: | `NXOpen.Point3d`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Point`

  Parameters: | point (`NXOpen.Point3d`) –

  New in version NX8.5.0.

  License requirements: None.

## ShowShortcuts

`SpecifyVector.``ShowShortcuts`

  Returns or sets the ShowShortcuts

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

  Getter Method

  Signature `ShowShortcuts`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowShortcuts`

  Parameters: | show (bool) –

  New in version NX8.5.0.

  License requirements: None.

## SnapPointTypesOnByDefault

`SpecifyVector.``SnapPointTypesOnByDefault`

  Returns or sets the SnapPointTypesOnByDefault

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

  Getter Method

  Signature `SnapPointTypesOnByDefault`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SnapPointTypesOnByDefault`

  Parameters: | snapTypesByDefault (int) –

  New in version NX8.5.0.

  License requirements: None.

## StepStatusAsString

`SpecifyVector.``StepStatusAsString`

  Returns or sets the StepStatus as string

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

  Getter Method

  Signature `StepStatusAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `StepStatusAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## Vector

`SpecifyVector.``Vector`

  Returns or sets the Vector

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

  Getter Method

  Signature `Vector`

  Returns: |
  Return type: | `NXOpen.Vector3d`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Vector`

  Parameters: | vector (`NXOpen.Vector3d`) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## GetBalloonTooltipLayoutMembers

`SpecifyVector.``GetBalloonTooltipLayoutMembers`

  Gets the BalloonTooltipLayout members

  Signature `GetBalloonTooltipLayoutMembers()`

  Returns: | Value to get from the property.
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetInterpartSelectionMembers

`SpecifyVector.``GetInterpartSelectionMembers`

  Gets the InterpartSelection members

  Signature `GetInterpartSelectionMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetSelectedObjects

`SpecifyVector.``GetSelectedObjects`

  Gets the SelectedObjects

  Signature `GetSelectedObjects()`

  Returns: | Value to get from the property
  Return type: | list of `NXOpen.TaggedObject`

  New in version NX8.5.0.

  License requirements: None.

## GetStepStatusMembers

`SpecifyVector.``GetStepStatusMembers`

  Gets the StepStatus

  Signature `GetStepStatusMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## SetSelectedObjects

`SpecifyVector.``SetSelectedObjects`

  Sets the SelectedObjects

  Signature `SetSelectedObjects(objectVector)`

  Parameters: | objectVector (list of `NXOpen.TaggedObject`) – Value to set for the property

  New in version NX8.5.0.

  License requirements: None.