Class EsriSimpleLineSymbol

Hierarchy

LineSymbol
- EsriSimpleLineSymbol

Index

Constructors

constructor

new EsriSimpleLineSymbol(properties?): EsriSimpleLineSymbol
SimpleLineSymbol is used for rendering 2D polyline geometries in a 2D MapView.

Read more...
Parameters
- Optional properties: SimpleLineSymbolProperties
Returns EsriSimpleLineSymbol
Overrides LineSymbol.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:70188

Properties

cap

cap: "butt" | "round" | "square"

Specifies the cap style.

Default

round

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#cap)

color

color: EsriColour

The color of the symbol.

Default

black

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol.html#color)

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

join

join: "round" | "miter" | "bevel"

Specifies the join style.

Default

round

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#join)

marker

marker: null | LineSymbolMarker

Specifies the color, style, and placement of a symbol marker on the line.

miterLimit

miterLimit: number

Maximum allowed ratio of the width of a miter join to the line width.

Default

2

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#miterLimit)

style

Specifies the line style.

Default

solid

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html#style)

type

type: "simple-line"

The symbol type.

width

width: number

The width of the symbol in points.

Default

0.75

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol.html#width)

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from LineSymbol._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from LineSymbol._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriSimpleLineSymbol
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriSimpleLineSymbol
Inherited from LineSymbol._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from LineSymbol.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

clone

clone(): EsriSimpleLineSymbol
Creates a deep clone of the symbol.

Read more...

Returns EsriSimpleLineSymbol
- Defined in node_modules/@arcgis/core/interfaces.d.ts:70194

destroy

destroy(): void
Returns void
Inherited from LineSymbol.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from LineSymbol.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from LineSymbol.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from LineSymbol.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from LineSymbol.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from LineSymbol.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from LineSymbol.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

set

set<T>(propertyName, value): EsriSimpleLineSymbol
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriSimpleLineSymbol
Inherited from LineSymbol.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriSimpleLineSymbol
Parameters
- props: HashMap<any>
Returns EsriSimpleLineSymbol
Inherited from LineSymbol.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

toJSON

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

Read more...

Returns any
Inherited from LineSymbol.toJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2167

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from LineSymbol.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

`Static` fromJSON

fromJSON(json): EsriSimpleLineSymbol
Parameters
- json: any
Returns EsriSimpleLineSymbol
Overrides LineSymbol.fromJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:70195

Class EsriSimpleLineSymbol

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: SimpleLineSymbolProperties

Returns EsriSimpleLineSymbol

Properties

cap

Default

color

Default

declaredClass

destroyed

initialized

join

Default

marker

miterLimit

Default

style

Default

type

width

Default

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriSimpleLineSymbol

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

clone

Returns EsriSimpleLineSymbol

destroy

Returns void

get

Type Parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

hasHandles

Type Parameters

T

Parameters

Optional groupKey: Exclude<T, IHandle>

Returns boolean

Protected notifyChange

Parameters

propertyName: string

Returns void

own

Deprecated

Parameters

handles: IHandle | IHandle[]

`Optional` properties: SimpleLineSymbolProperties

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Optional` groupKey: Exclude<T, IHandle>

`Protected` notifyChange

`Optional` groupKey: Exclude<T, IHandle>

`Optional` sync: boolean

`Static` fromJSON