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);

Index

Constructors

Accessors

Constructors

cee.usg.ScalarSettings.constructor()
ScalarSettings(): ScalarSettings

Returns: ScalarSettings

Accessors

cee.usg.ScalarSettings.name()
get name(): string

The name of the scalar result

Returns: string

set name(name: string): void

Parameters

name: string

Returns: void

cee.usg.ScalarSettings.scalarMapper()
get scalarMapper(): ScalarMapperContinuousDomain

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

EnvisionWeb offers 4 different scalar mappers:

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

Returns: ScalarMapperContinuousDomain

set scalarMapper(scalarMapper: ScalarMapperContinuousDomain): void

Parameters

Returns: void