# 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

- `constructor`

Accessors

- `name`
- `scalarMapper`

## 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

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Web in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...