Class SymbologyAPI

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

APIScope

Hierarchy (View Summary)

APIScope
- SymbologyAPI

Constructors

constructor

new SymbologyAPI(iApi: InstanceAPI): SymbologyAPI
Parameters
- iApi: InstanceAPI
Returns SymbologyAPI
Overrides APIScope.constructor
- Defined in src/geo/utils/symbology.ts:35

Properties

`Readonly`$iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

`Protected`CLASS_BREAKS

CLASS_BREAKS: string = 'class-breaks'

`Protected`CONTAINER_CENTER

CONTAINER_CENTER: number = ...

`Protected`CONTAINER_SIZE

CONTAINER_SIZE: number = 32

`Protected`CONTENT_IMAGE_SIZE

CONTENT_IMAGE_SIZE: number = 28

`Protected`CONTENT_PADDING

CONTENT_PADDING: number = ...

`Protected`CONTENT_SIZE

CONTENT_SIZE: number = 24

`Protected`NONE

NONE: string = 'none'

`Protected`SIMPLE

SIMPLE: string = 'simple'

`Protected`UNIQUE_VALUE

UNIQUE_VALUE: string = 'unique-value'

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from APIScope.$element
- Defined in src/api/common.ts:32

$vApp

get $vApp(): ComponentPublicInstance
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Returns ComponentPublicInstance
Memberof
APIScope
Inherited from APIScope.$vApp
- Defined in src/api/common.ts:28

Methods

fitInto

fitInto(element: any, CONTAINER_SIZE: number): void
Fits svg element in the size specified
Parameters
- element: any
  svg element to fit
- CONTAINER_SIZE: number
  width/height of a container to fit the element into
Returns void
- Defined in src/geo/utils/symbology.ts:700

generateBlankSymbology

generateBlankSymbology(): Promise<string>
Returns Promise<string>
- Defined in src/geo/utils/symbology.ts:288

generateWMSSymbology

generateWMSSymbology(imageUri: string): Promise<object>
Function
Generates svg symbology for WMS layers. generateWMSSymbology
Parameters
- imageUri: string
  url or dataUrl of the legend image
Returns Promise<object>
a promise resolving with symbology svg code and its label
- Defined in src/geo/utils/symbology.ts:102

getGraphicIcon

getGraphicIcon(attributes: Attributes, renderer: BaseRenderer): string
Given feature attributes, return the image URL for that feature/graphic object.
Parameters
- attributes: Attributes
  object of feature attribute key value pairs
- renderer: BaseRenderer
  an enhanced renderer (see function enhanceRenderer)
Returns string
svgcode Url to the features symbology image

Method
getGraphicIcon
- Defined in src/geo/utils/symbology.ts:59

getGraphicSymbol

getGraphicSymbol(attributes: object, renderer: BaseRenderer): Symbol2DUnion
Given feature attributes, return the symbol for that feature/graphic object.
Parameters
- attributes: object
  object of feature attribute key value pairs
- renderer: BaseRenderer
  an enhanced renderer (see function enhanceRenderer)
Returns Symbol2DUnion
an ESRI Symbol object in server format

Method
getGraphicSymbol
- Defined in src/geo/utils/symbology.ts:71

listToIconSymbology

listToIconSymbology(list: any[]): any[]
Parameters
- list: any[]
Returns any[]
- Defined in src/geo/utils/symbology.ts:162

listToImageSymbology

listToImageSymbology(list: any[]): any[]
Parameters
- list: any[]
Returns any[]
- Defined in src/geo/utils/symbology.ts:166

makeRenderer

makeRenderer(
    esriRenderer: RendererUnion,
    fields: FieldDefinition[],
    falseRenderer?: boolean,
): BaseRenderer
Parameters
- esriRenderer: RendererUnion
- fields: FieldDefinition[]
- falseRenderer: boolean = false
Returns BaseRenderer
- Defined in src/geo/utils/symbology.ts:75

mapServerToLocalLegend

mapServerToLocalLegend(
mapServerUrl: string,
layerIndex?: string | number,
): Promise<LegendSymbology[]>
Function
Orchestrator function that will:
- Fetch a legend from an esri map server
- Extract legend for a specific sub layer
- Convert server legend to a temporary renderer
- Convert temporary renderer to a viewer-formatted legend (return value)
mapServerToLocalLegend
Parameters
- mapServerUrl: string
  service url (root service, not indexed endpoint)
- OptionallayerIndex: string | number = undefined
  the index of the layer in the legend we are interested in. If not provided, all layers will be collapsed into a single legend
Returns Promise<LegendSymbology[]>
resolves in a viewer-compatible legend for the given server and layer index
- Defined in src/geo/utils/symbology.ts:922

rendererToLegend

rendererToLegend(renderer: BaseRenderer): LegendSymbology[]
Generate a legend object based on an ESRI renderer.
Parameters
- renderer: BaseRenderer
  an ESRI renderer object in server JSON form
Returns LegendSymbology[]
list of legend symbologies
- Defined in src/geo/utils/symbology.ts:717

renderSymbologyIcon

renderSymbologyIcon(imageUri: string, draw?: any): Promise<string>
Function
Renders a supplied image as an icon-style symbology item (fitting an image inside an icon container, usually 32x32 pixels).

renderSymbologyIcon
Parameters
- imageUri: string
  a image dataUrl or a regular url
- draw: any = null
  [optional=null] an svg container to draw the image on; if not supplied, a new one is created
Returns Promise<string>
- Defined in src/geo/utils/symbology.ts:211

renderSymbologyImage

renderSymbologyImage(imageUri: string, draw?: any): Promise<string>
Function
Renders a supplied image as an image-style symbology item (preserving the true image dimensions).

renderSymbologyImage
Parameters
- imageUri: string
  a image dataUrl or a regular url
- draw: any = null
  [optional=null] an svg container to draw the image on; if not supplied, a new one is created
Returns Promise<string>
- Defined in src/geo/utils/symbology.ts:177

Class SymbologyAPI

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SymbologyAPI

Properties

Readonly$iApi

Memberof

ProtectedCLASS_BREAKS

ProtectedCONTAINER_CENTER

ProtectedCONTAINER_SIZE

ProtectedCONTENT_IMAGE_SIZE

ProtectedCONTENT_PADDING

ProtectedCONTENT_SIZE

ProtectedNONE

ProtectedSIMPLE

ProtectedUNIQUE_VALUE

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance

Memberof

Methods

fitInto

Parameters

Returns void

generateBlankSymbology

Returns Promise<string>

generateWMSSymbology

Parameters

Returns Promise<object>

getGraphicIcon

Parameters

Returns string

Method

getGraphicSymbol

Parameters

Returns Symbol2DUnion

Method

listToIconSymbology

Parameters

Returns any[]

listToImageSymbology

Parameters

Returns any[]

makeRenderer

Parameters

Returns BaseRenderer

mapServerToLocalLegend

Parameters

Returns Promise<LegendSymbology[]>

rendererToLegend

Parameters

Returns LegendSymbology[]

renderSymbologyIcon

Parameters

Returns Promise<string>

renderSymbologyImage

Parameters

Returns Promise<string>

Settings

On This Page

`Readonly`$iApi

`Protected`CLASS_BREAKS

`Protected`CONTAINER_CENTER

`Protected`CONTAINER_SIZE

`Protected`CONTENT_IMAGE_SIZE

`Protected`CONTENT_PADDING

`Protected`CONTENT_SIZE

`Protected`NONE

`Protected`SIMPLE

`Protected`UNIQUE_VALUE