ScalarSettings

class cee.usg.ScalarSettings()

Setting for how a scalar should be shown in the model.

You can get the settings for the scalar shown as fringes (filled contours) with the UnstructGridModel.fringesSettings property.

Example using the ScalarMapperFilledContoursUniform:

// Configure the mapper to use, and
const mapper = new cee.ScalarMapperFilledContoursUniform();
mapper.colorArray = cee.ColorTableFactory.color4TableArray(cee.ColorTable.RAINBOW, 15);
mapper.setRange(1,4);
model.fringesSettings.scalarMapper = mapper;

// Add a color legend based on the mapper
this.m_view.overlay.addCustomColorLegendForScalarMapper(mapper, "Demo result", 1);

Constructors

Accessors

Constructors

ScalarSettings.constructor()
Return type:ScalarSettings

Accessors

ScalarSettings.name()

The name of the scalar result

Return type:string
ScalarSettings.name(name)
Arguments:
  • name (string) – None
Return type:

void
ScalarSettings.scalarMapper()

The scalar mapper to use to map from a scalar value to a color

EnvisionWeb offers 4 different scalar mappers:

  • cee.ScalarMapperFilledContours
  • cee.ScalarMapperFilledContoursUniform
  • cee.ScalarMapperContinuous
  • cee.ScalarMapperContinuousPiecewise

To add a color legend to a view to show the scalar mapper, use the cee.Overlay.addCustomColorLegendForScalarMapper method (see example above).

Return type:ScalarMapperContinuousDomain
ScalarSettings.scalarMapper(scalarMapper)
Arguments:
  • scalarMapper (ScalarMapperContinuousDomain) – None
Return type:

void