SetPlotFolderSettings

Sets the attributes of all plots in the specified folder.

UI Access

[product] > Fields > Modify Plot Attributes

Parameters

Name	Type	Description
<PlotFolderName>	String	Name of the folder with the attributes to modify.
<PlotFolderAttributes>	Array	Structured array. Array("NAME:FieldsPlotSettings", "Real time mode:=", <bool>, <ColorMapSettings>, <Scale3DSettings>, <Marker3DSettings>, <Arrow3DSettings>)
<ColorMapSettings>	Array	Structured array. Array("NAME:ColorMapSettings", "ColorMapType:=", <string Possible values are "Uniform", "Ramp", "Spectrum">, "SpectrumType:=", <string Possible values are "Rainbow", "Temperature", "Magenta", "Gray">, "UniformColor:=", <array containing the R, G, B components of the color. Components should be in the range 0 to 255.>, "RampColor:=", <array containing the R, G, B components of the color. Components should be in the range 0 to 255.>)
<Scale3DSettings>	Array	Structured array. Array("NAME:Scale3DSettings", "m_nLevels:=", <int>, "m_autoScale:=", <bool>, "minvalue:=", <double>, "maxvalue:=", <double>, "log:=", <bool>, "IntrinsicMin:=", <double>, "IntrinsicMax:=", <double>)
<Marker3DSettings>	Array	Structured array. Array("NAME:Marker3DSettings", "MarkerType:=", <integer 9:Sphere 10: Box 11: Tetrahedron 12: Octahedron default: Sphere>, "MarkerMapSize:=", <bool>, "MarkerMapColor:=", <bool>, "MarkerSize:=", <double>)
<Arrow3DSettings>	Array	Structured array. Array("NAME:Arrow3DSettings", "ArrowType:=", <integer 0: Line 1: Cylinder 2: Umbrella default: Line>, "ArrowMapSize:=", <bool>, "ArrowMapColor:=", <bool>, "ShowArrowTail:=", <bool>, "ArrowSize:=", <double>)

Return Value

None.

Python Syntax

SetPlotFolderSettings(<PlotFolderName>, <PlotFolderAttributes>)

Python Example

oModule.SetPlotFolderSettings("E Field1",
["NAME:FieldsPlotSettings", 
"Real time mode:=", True, 
["NAME:ColorMapSettings", 
"ColorMapType:=", "Spectrum", 
"SpectrumType:=", "Rainbow", 
"UniformColor:=", [127, 255, 255],
"RampColor:=", [255, 127, 127]], 
["NAME:Scale3DSettings", 
"m_nLevels:=", 27,
"m_autoScale:=", True,
"minvalue:=", 9.34379863739014, 
"maxvalue:=", 13683.755859375, 
"log:=", False, 
"IntrinsicMin:=", 9.34379863739014, 
"IntrinsicMax:=", 13683.755859375), 
["NAME:Marker3DSettings", 
"MarkerType:=", 0, 
"MarkerMapSize:=", True, 
"MarkerMapColor:=", False, 
"MarkerSize:=", 0.25], 
["NAME:Arrow3DSettings", 
"ArrowType:=", 1, 
"ArrowMapSize:=", True, 
"ArrowMapColor:=", True, 
"ShowArrowTail:=", True, 
"ArrowSize:=", 0.25]]
)