ViewLabelBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ViewLabelBuilder Class

class `NXOpen.Drawings.``ViewLabelBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.Drawings.ViewLabelBuilder`

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
CustomizedViewLabel | Returns or sets the customized view label
IncludeParentheses | Returns or sets the include parentheses
IncludeRotationAngle | Returns or sets the include rotation angle
IncludeRotationSymbol | Returns or sets the include rotation symbol
LabelCharacterHeightFactor | Returns or sets the label character height factor
LabelPosition | Returns or sets the label position
LabelPrefix | Returns or sets the label prefix
LetterFormat | Returns or sets the letter format
PrefixCharacterHeightFactor | Returns or sets the prefix character height factor
ReferenceToShow | Returns or sets the reference to show
RotationSymbolType | Returns or sets the rotation symbol type
ScaleCharacterHeightFactor | Returns or sets the scale character height factor
ScalePosition | Returns or sets the scale position
ScalePrefix | Returns or sets the scale prefix
ShowViewLabel | Returns or sets the show view label
ShowViewScale | Returns or sets the show view scale
Tag | Returns the Tag for this object.
ValueFormat | Returns or sets the value format
ViewLabelOption | Returns or sets the view label option

# Methods

Method | Description
--- | ---
GetCustomizedViewLabelText | Returns the customized view label text
SetCustomizedViewLabelText | Sets the customized view label text
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## CustomizedViewLabel

`ViewLabelBuilder.``CustomizedViewLabel`

  Returns or sets the customized view label

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

  Getter Method

  Signature `CustomizedViewLabel`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CustomizedViewLabel`

  Parameters: | customizedViewLabel (bool) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## IncludeParentheses

`ViewLabelBuilder.``IncludeParentheses`

  Returns or sets the include parentheses

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

  Getter Method

  Signature `IncludeParentheses`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IncludeParentheses`

  Parameters: | includeParentheses (bool) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## IncludeRotationAngle

`ViewLabelBuilder.``IncludeRotationAngle`

  Returns or sets the include rotation angle

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

  Getter Method

  Signature `IncludeRotationAngle`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IncludeRotationAngle`

  Parameters: | includeRotationAngle (bool) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## IncludeRotationSymbol

`ViewLabelBuilder.``IncludeRotationSymbol`

  Returns or sets the include rotation symbol

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

  Getter Method

  Signature `IncludeRotationSymbol`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  Deprecated since version NX11.0.1: Use `NXOpen.Drawings.ViewLabelBuilder.RotationSymbolType()` instead.

  License requirements: None.

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

  Setter Method

  Signature `IncludeRotationSymbol`

  Parameters: | includeRotationSymbol (bool) –

  New in version NX9.0.0.

  Deprecated since version NX11.0.1: Use `NXOpen.Drawings.ViewLabelBuilder.RotationSymbolType()` instead.

  License requirements: drafting (“DRAFTING”)

## LabelCharacterHeightFactor

`ViewLabelBuilder.``LabelCharacterHeightFactor`

  Returns or sets the label character height factor

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

  Getter Method

  Signature `LabelCharacterHeightFactor`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelCharacterHeightFactor`

  Parameters: | labelCharacterHeightFactor (float) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## LabelPosition

`ViewLabelBuilder.``LabelPosition`

  Returns or sets the label position

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

  Getter Method

  Signature `LabelPosition`

  Returns: |
  Return type: | `NXOpen.Drawings.LabelPositionTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelPosition`

  Parameters: | labelPosition (`NXOpen.Drawings.LabelPositionTypes`) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## LabelPrefix

`ViewLabelBuilder.``LabelPrefix`

  Returns or sets the label prefix

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

  Getter Method

  Signature `LabelPrefix`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelPrefix`

  Parameters: | labelPrefix (str) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## LetterFormat

`ViewLabelBuilder.``LetterFormat`

  Returns or sets the letter format

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

  Getter Method

  Signature `LetterFormat`

  Returns: |
  Return type: | `NXOpen.Drawings.LetterFormatTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LetterFormat`

  Parameters: | letterFormat (`NXOpen.Drawings.LetterFormatTypes`) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## PrefixCharacterHeightFactor

`ViewLabelBuilder.``PrefixCharacterHeightFactor`

  Returns or sets the prefix character height factor

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

  Getter Method

  Signature `PrefixCharacterHeightFactor`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PrefixCharacterHeightFactor`

  Parameters: | prefixCharacterHeightFactor (float) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## ReferenceToShow

`ViewLabelBuilder.``ReferenceToShow`

  Returns or sets the reference to show

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

  Getter Method

  Signature `ReferenceToShow`

  Returns: |
  Return type: | `NXOpen.Drawings.ReferenceShowTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReferenceToShow`

  Parameters: | referenceToShow (`NXOpen.Drawings.ReferenceShowTypes`) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## RotationSymbolType

`ViewLabelBuilder.``RotationSymbolType`

  Returns or sets the rotation symbol type

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

  Getter Method

  Signature `RotationSymbolType`

  Returns: |
  Return type: | `NXOpen.Drawings.RotationSymbolTypes`

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `RotationSymbolType`

  Parameters: | rotationSymbolType (`NXOpen.Drawings.RotationSymbolTypes`) –

  New in version NX11.0.1.

  License requirements: drafting (“DRAFTING”)

## ScaleCharacterHeightFactor

`ViewLabelBuilder.``ScaleCharacterHeightFactor`

  Returns or sets the scale character height factor

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

  Getter Method

  Signature `ScaleCharacterHeightFactor`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ScaleCharacterHeightFactor`

  Parameters: | scaleCharacterHeightFactor (float) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## ScalePosition

`ViewLabelBuilder.``ScalePosition`

  Returns or sets the scale position

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

  Getter Method

  Signature `ScalePosition`

  Returns: |
  Return type: | `NXOpen.Drawings.ScalePositionTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ScalePosition`

  Parameters: | scalePosition (`NXOpen.Drawings.ScalePositionTypes`) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## ScalePrefix

`ViewLabelBuilder.``ScalePrefix`

  Returns or sets the scale prefix

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

  Getter Method

  Signature `ScalePrefix`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ScalePrefix`

  Parameters: | scalePrefix (str) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## ShowViewLabel

`ViewLabelBuilder.``ShowViewLabel`

  Returns or sets the show view label

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

  Getter Method

  Signature `ShowViewLabel`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowViewLabel`

  Parameters: | showViewLabel (bool) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## ShowViewScale

`ViewLabelBuilder.``ShowViewScale`

  Returns or sets the show view scale

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

  Getter Method

  Signature `ShowViewScale`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowViewScale`

  Parameters: | showViewScale (bool) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## ValueFormat

`ViewLabelBuilder.``ValueFormat`

  Returns or sets the value format

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

  Getter Method

  Signature `ValueFormat`

  Returns: |
  Return type: | `NXOpen.Drawings.ScaleValueFormatTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ValueFormat`

  Parameters: | valueFormat (`NXOpen.Drawings.ScaleValueFormatTypes`) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewLabelOption

`ViewLabelBuilder.``ViewLabelOption`

  Returns or sets the view label option

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

  Getter Method

  Signature `ViewLabelOption`

  Returns: |
  Return type: | `NXOpen.Drawings.ViewLabelTypes`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ViewLabelOption`

  Parameters: | viewLabelOption (`NXOpen.Drawings.ViewLabelTypes`) –

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

# Method Detail

## GetCustomizedViewLabelText

`ViewLabelBuilder.``GetCustomizedViewLabelText`

  Returns the customized view label text

  Signature `GetCustomizedViewLabelText()`

  Returns: |
  Return type: | list of str

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## SetCustomizedViewLabelText

`ViewLabelBuilder.``SetCustomizedViewLabelText`

  Sets the customized view label text

  Signature `SetCustomizedViewLabelText(customizedText)`

  Parameters: | customizedText (list of str) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## Validate

`ViewLabelBuilder.``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.