MarkerStyleSetting Class — NXOpen Python API Reference 12.0.0 documentation

# MarkerStyleSetting Class

class `NXOpen.CAE.Xyplot.``MarkerStyleSetting`

  Bases: `NXOpen.CAE.Xyplot.TextStyleSetting`

  Represents the marker display style.

  Call `CAE.Xyplot.BaseDisplayStyleSetting.CommitChange()` to apply style changes to corresponding plot after it’s modified.

  Not support KF.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
AbsPercentage | Returns or sets the scale of abscissa percentage setting, just for attachment type: Abscissa Percentage, and the value shuould be limited in [0.
Alignment | Returns or sets the text alignment.
AttachmentType | Returns or sets the attachment type for associative marker
Color | Returns or sets the text color
Font | Returns or sets the text font
FontStyle | Returns or sets the text font style.
FontType | Returns or sets the text font type
GlobalSizeScale | Returns or sets the scale of global text size.
IsGlobalSizeAutoScaled | Returns or sets a value indicating whether to automatically adjust the scale of global text size to fit the screen.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
LeaderStyle | Returns the leader style
NoteTextVisibility | Returns or sets the option specifies whether to show note text
NumberFormat | Returns the number format options
NumberTextVisibility | Returns or sets the option specifies whether to show number text
Orientation | Returns or sets the text orientation.
Owner | Returns the owner style
Size | Returns or sets the text size.
SnapToData | Returns or sets the option specifies whether just to search source data when creating associative marker
Tag | Returns the Tag for this object.
TextBoxStyle | Returns the style of text box
UseGlobalFontSetting | Returns or sets a value indicating whether to use the global setting of text font, font style and font size.
Visibility | Returns or sets the visibility
Weight | Returns or sets the text weight.

# Methods

Method | Description
--- | ---
CommitChange | Commits any edits that have been applied to the display style.
Find | Finds the `NXOpen.TaggedObject` with the given identifier as recorded in a journal.
GetNoteTexts | Gets the note texts
SetNoteTexts | Sets the note texts

# Property Detail

## AbsPercentage

`MarkerStyleSetting.``AbsPercentage`

  Returns or sets the scale of abscissa percentage setting, just for attachment type: Abscissa Percentage, and the value shuould be limited in [0.

  0, 1.0]

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

  Getter Method

  Signature `AbsPercentage`

  Returns: | abscissa percentage
  Return type: | float

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AbsPercentage`

  Parameters: | absPercentage (float) – abscissa percentage

  New in version NX12.0.0.

  License requirements: None.

## AttachmentType

`MarkerStyleSetting.``AttachmentType`

  Returns or sets the attachment type for associative marker

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

  Getter Method

  Signature `AttachmentType`

  Returns: | attachment type
  Return type: | `NXOpen.CAE.Xyplot.AnchorType`

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AttachmentType`

  Parameters: | anchorType (`NXOpen.CAE.Xyplot.AnchorType`) – attachment type

  New in version NX12.0.0.

  License requirements: None.

## NoteTextVisibility

`MarkerStyleSetting.``NoteTextVisibility`

  Returns or sets the option specifies whether to show note text

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

  Getter Method

  Signature `NoteTextVisibility`

  Returns: | note text
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NoteTextVisibility`

  Parameters: | isNoteTextVisible (bool) – note text

  New in version NX12.0.0.

  License requirements: None.

## NumberTextVisibility

`MarkerStyleSetting.``NumberTextVisibility`

  Returns or sets the option specifies whether to show number text

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

  Getter Method

  Signature `NumberTextVisibility`

  Returns: | number text
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberTextVisibility`

  Parameters: | isNumberTextVisible (bool) – number text

  New in version NX12.0.0.

  License requirements: None.

## Owner

`MarkerStyleSetting.``Owner`

  Returns the owner style

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

  Getter Method

  Signature `Owner`

  Returns: |
  Return type: | `NXOpen.CAE.Xyplot.IDisplayStyle`

  New in version NX10.0.0.

  License requirements: None.

## SnapToData

`MarkerStyleSetting.``SnapToData`

  Returns or sets the option specifies whether just to search source data when creating associative marker

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

  Getter Method

  Signature `SnapToData`

  Returns: | snap to data
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SnapToData`

  Parameters: | isSnapToData (bool) – snap to data

  New in version NX12.0.0.

  License requirements: None.

## Visibility

`MarkerStyleSetting.``Visibility`

  Returns or sets the visibility

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

  Getter Method

  Signature `Visibility`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Visibility`

  Parameters: | visibility (bool) –

  New in version NX12.0.0.

  License requirements: None.

# Method Detail

## CommitChange

`MarkerStyleSetting.``CommitChange`

  Commits any edits that have been applied to the display style.

  Triggers the corresponding plot to update graph.

  Signature `CommitChange()`

  New in version NX9.0.0.

  License requirements: None.

## GetNoteTexts

`MarkerStyleSetting.``GetNoteTexts`

  Gets the note texts

  Signature `GetNoteTexts()`

  Returns: | Note Texts
  Return type: | list of str

  New in version NX12.0.0.

  License requirements: None.

## SetNoteTexts

`MarkerStyleSetting.``SetNoteTexts`

  Sets the note texts

  Signature `SetNoteTexts(noteTexts)`

  Parameters: | noteTexts (list of str) – Note Texts

  New in version NX12.0.0.

  License requirements: None.