Gets the color options for the specified plot.
.NET Syntax
Visual Basic (Declaration) | |
---|
Function GetPlotColorOptions( _
ByVal SPlotName As System.String, _
ByRef NType As System.Integer, _
ByRef NBaseColor As System.Integer, _
ByRef NContour As System.Integer, _
ByRef BFlip As System.Boolean, _
ByRef BSpecifyColorLimit As System.Boolean, _
ByRef VarColor As System.Object _
) As System.Integer |
Visual Basic (Usage) | |
---|
Dim instance As ICWResults
Dim SPlotName As System.String
Dim NType As System.Integer
Dim NBaseColor As System.Integer
Dim NContour As System.Integer
Dim BFlip As System.Boolean
Dim BSpecifyColorLimit As System.Boolean
Dim VarColor As System.Object
Dim value As System.Integer
value = instance.GetPlotColorOptions(SPlotName, NType, NBaseColor, NContour, BFlip, BSpecifyColorLimit, VarColor) |
Parameters
- SPlotName
- Plot name (see Remarks)
- NType
- Color map as defined in swsColorChartOptionLegendTypeValue_e (see Remarks)
- NBaseColor
- Number of base colors in color map specified by NType (see Remarks)
- NContour
- Number of gradient colors
- BFlip
- True to reverse the color mapping, false to not
- BSpecifyColorLimit
- True to specify a color for values above the yield limit, false to not; valid only for von Mises stress plots of single body parts where the yield strength is defined
- VarColor
Array of RGB triplets:
- RGB color for values above the yield limit; valid only if BSpecifyColorLimit is true
- One or more RGB triplets of user-defined colors
Return Value
Error as defined in
swsResultsError_e
Example
Remarks
See Also
Availability
SOLIDWORKS Simulation API 2015 SP0