The color for the parts of the model that are above the current range.
Default is undefined, which means that the top color of the colorScheme will be used.
Note: Changing the colorScheme will set aboveRangeColor and belowRangeColor to undefined.
Auto range mode. Set this value with setAutoRange.
To disable auto range, set a manual range with setRange.
The color for the parts of the model that are below the current range.
Default is undefined, which means that the bottom color of the colorScheme will be used.
Note: Changing the colorScheme will set aboveRangeColor and belowRangeColor to undefined.
Additional color legend markers that can be shown above or below the main markers in the legend.
Useful for describing above, below and undefined colors.
Example: Add a "No result" marker below the color legend:
scalarSettings.colorMarkerArray = [
{
position: cee.ug.LegendColorMarkerPosition.BELOW,
color: new cee.Color3(0.5, 0.5, 0.5),
description: "No result"
}
];
The color scheme to use for the color legend and mapped colors on the model.
Note: Changing the colorScheme will set aboveRangeColor and belowRangeColor to undefined.
Setup the color legend with the given level colors.
The color scheme will be set to CUSTOM, and the number of levels will be set to the length of the provided array.
Get the colors of the current color legend (if in levels mode)
If levelCount > 0, this will return the colors for each level on the color legend, starting from the bottom of the legend.
Note: If not using customFilledContoursColorArr, the color legend info needs to be received from the server before this method will return valid info, so make sure the current update of display model is fully completed.
Whether auto range is enabled.
Specifies the visibility of the color legend.
The legend can be set to appear if used by any part in the model (AUTO, default), to always be shown (ALWAYS) or to never be shown (NEVER)
The number of levels (unique colors) in the color legend.
If you want a continuous (smooth) legend, set the number of levels to 0. This will create a continuous legend with tick marks at round numbers.
If true, a logarithmic range will be used for the color legend and results mapping.
If false, a linear mapping will be used.
Specify if the scalar result should be shown as a node averaged result or not.
If false (default) the result is shown as is computed. If true, a node averaged result will be shown that is derived from the original result.
The numerical format to use for the numbers on the color legend tick marks
Legal options: 'g': (default) (using the .toPrecision JS function). 'f': fixed notation (1234.0) (using the .toFixed() JS function) 'e': scientific notation (1.234e4) (using the .toExponential JS function)
The precision is controlled by the numericPrecision property.
Set the precision to use for the numbers on the color legend tick marks
See numericFormat for the different options.
The maximum range of the scalar result if auto range is disabled. This is undefined if auto range is enabled.
To set a manual range, use the setRange function.
The minimum range of the scalar result if auto range is disabled. This is undefined if auto range is enabled.
To set a manual range, use the setRange function.
The id (>=0) of the scalar result. This id corresponds to the id in ModelDirectory.scalarResultArray.
Constant scaling term used for custom scaling of the legend.
The value shown on the legend tick marks is:
legendValue = scalingConstantTerm + scalarValue*scalingFirstDegreeTerm
First degree term used for custom scaling of the legend.
The value shown on the legend tick marks is:
legendValue = scalingConstantTerm + scalarValue*scalingFirstDegreeTerm
The color of the parts of the model with an undefined result.
Gets the settings for this object as a Plain Old JavaScript Object (POJO).
Maps the given domain value to a color using the current scalar settings
Sets the automatic full range of the scalar result.
Set this to AutoRangeMode.ALL_ITEMS to use the full range for the result (this is the default) or to AutoRangeMode.VISIBLE_ITEMS to limit the range to the currently visible parts
Applies the settings in the given properties object to this scalar settings
Sets a user defined range of the scalar result.
This function will disable auto range.
Generated using TypeDoc
Specification of how to render scalar results on the model, on cutting planes, on isosurfaces and on particle traces.
Use this object to control the visual appearance of scalar results in the 3D viewer. You can specify which colorScheme to use for the color legend and how many levels (unique colors) it should have with levelCount. You can also control the legend's scaling, either by using autoRangeMode or by specifying rangeMinimum and rangeMaximum.
Example: Setup a custom color legend
var modelSpec = myModel.modelSpec; var resultId = modelSpec.fringesResultId; if (resultId >= 0) { var scalarSettings = myModel.getScalarSettingsById(resultId); var min = myModel.getScalarResultMinimumValue(resultId); var max = myModel.getScalarResultMaximumValue(resultId); var range = max - min; // Setup custom scale 50% -> 100% of the range using a green to brown legend. scalarSettings.setRange(min + range*0.5, max); scalarSettings.colorScheme = cee.ug.ColorScheme.WHITE_TO_BROWN; scalarSettings.levelCount = 3; }
This code sample produces the following image in the 3D Viewer: