Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClassBreaksRenderer

Hierarchy

Index

Properties

authoringInfo

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

backgroundFillSymbol: FillSymbol | PolygonSymbol3D

When symbolizing polygon features with graduated symbols, set a FillSymbol on this property to visualize the boundaries of each feature.

Read more...

classBreakInfos

classBreakInfos: ClassBreakInfo[]

Each element in the array is an object that provides information about a class break associated with the renderer.

Read more...

declaredClass

declaredClass: string

defaultLabel

defaultLabel: string

Label used in the Legend to describe features assigned the default symbol.

Read more...

defaultSymbol

defaultSymbol: Symbol

The default symbol assigned to features with a value not matched to a given break.

Read more...

destroyed

destroyed: boolean

field

field: string

The name of a numeric attribute field whose data determines the symbol of each feature based on the class breaks defined in classBreakInfos.

Read more...

initialized

initialized: boolean

legendOptions

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

Read more...

normalizationField

normalizationField: string

When normalizationType is field, this property contains the attribute field name used for normalization.

Read more...

normalizationTotal

normalizationTotal: number

When normalizationType is percent-of-total, this property contains the total of all data values.

Read more...

normalizationType

normalizationType: "field" | "log" | "percent-of-total"

Indicates how the data is normalized.

Read more...

Readonly type

type: "class-breaks"

The type of renderer.

Read more...

valueExpression

valueExpression: string

An Arcade expression evaluating to a number.

Read more...

valueExpressionTitle

valueExpressionTitle: string

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

Read more...

visualVariables

visualVariables: VisualVariable[]

An array of VisualVariable objects.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ClassBreaksRenderer

addClassBreakInfo

  • addClassBreakInfo(min: any, max?: number, symbol?: Symbol): void
  • Adds a class break to the renderer.

    Read more...

    Parameters

    • min: any
    • Optional max: number
    • Optional symbol: Symbol

    Returns void

clone

  • Creates a deep clone of the renderer.

    Read more...

    Returns ClassBreaksRenderer

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getClassBreakInfo

  • Returns the classBreakInfo information (as defined by the renderer) associated with the given graphic.

    Read more...

    Parameters

    Returns Promise<ClassBreakInfo>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

removeClassBreakInfo

  • removeClassBreakInfo(min: number, max: number): void
  • Removes a break from the renderer.

    Read more...

    Parameters

    • min: number
    • max: number

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ClassBreaksRenderer

  • Parameters

    Returns ClassBreaksRenderer

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

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

    Returns WatchHandle

Generated using TypeDoc