Class EsriUniqueValueRenderer

Hierarchy

Constructors

Properties

authoringInfo: AuthoringInfo

Authoring metadata only included in renderers generated from one of the Smart Mapping creator methods, such as sizeRendererCreator.createContinuousRenderer() or colorRendererCreator.createContinuousRenderer().

Read more...

backgroundFillSymbol: FillSymbol | PolygonSymbol3D

This property is only relevant When symbolizing polygon features with marker symbols (or IconSymbol3DLayer) in the uniqueValueInfos of this renderer.

Read more...

declaredClass: string
defaultLabel: string

The label used in the Legend to describe features assigned the default symbol.

Read more...

defaultSymbol: EsriSymbol

The symbol used to draw all features with values not referenced by uniqueValueInfos or uniqueValueGroups.

Read more...

destroyed: boolean
field: string

The name of the attribute field containing types or categorical values referenced in uniqueValueInfos or uniqueValueGroups.

Read more...

field2: string

Specifies the name of an additional attribute field used to categorize features.

Read more...

field3: string

Specifies the name of a third attribute field used to categorize features.

Read more...

fieldDelimiter: string

A string used as a separator between the values in the legend if multiple attribute fields are used to categorize values.

Read more...

initialized: boolean
legendOptions: UniqueValueRendererLegendOptions

An object providing options for displaying the renderer in the Legend.

Read more...

orderByClassesEnabled: boolean

Indicates whether the order of the classes or uniqueValueInfos in the renderer definition should be used for the feature drawing order of the layer.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#orderByClassesEnabled)
type: "unique-value"

The type of Renderer.

Read more...

uniqueValueGroups: UniqueValueGroup[]

An array of objects defining groups of unique values.

Read more...

uniqueValueInfos: EsriUniqueValueInfo[]

Defines categories and their corresponding symbols based on a set of values expected from the provided field or valueExpression.

Read more...

valueExpression: string

An Arcade expression following the specification defined by the Arcade Visualization Profile.

Read more...

valueExpressionTitle: string

The title identifying and describing the associated Arcade expression as defined in the valueExpression property.

Read more...

visualVariables: VisualVariable[]

An array of VisualVariable objects.

Read more...

Methods

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Type Parameters

    • T

    Parameters

    • handles: IHandle | IHandle[]
    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Adds a unique value and symbol to the renderer.

    Read more...

    Parameters

    • valueOrInfo: any
    • Optional symbol: EsriSymbol | SymbolProperties

    Returns void

  • Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns boolean

  • Parameters

    • propertyName: string

    Returns void

  • Deprecated

    Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.

    Parameters

    • handles: IHandle | IHandle[]

    Returns void

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Removes a unique value from the renderer.

    Read more...

    Parameters

    • value: string | number

    Returns void

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc