NextGIS Frontend
Preparing search index...
@nextgis/ngw-kit
Legend
Class Legend
Represents a legend for a specific layer.
Implements
LayerLegend
Index
Constructors
constructor
Properties
layer
layer
Id
legend?
legend
Symbols
resource
Id
Methods
attach
Layer
create
create
Legend
set
Legend
Symbol
set
Symbol
Render
Constructors
constructor
new
Legend
(
__namedParameters
:
LayerLegend
&
{
connector
?:
default
;
layer
:
LayerAdapter
;
onSymbolRenderChange
?:
(
indexes
:
number
[]
)
=>
void
;
resourceId
:
number
;
webMap
:
WebMap
;
}
,
)
:
Legend
Parameters
__namedParameters
:
LayerLegend
&
{
connector
?:
default
;
layer
:
LayerAdapter
;
onSymbolRenderChange
?:
(
indexes
:
number
[]
)
=>
void
;
resourceId
:
number
;
webMap
:
WebMap
;
}
Returns
Legend
Properties
layer
layer
:
LayerAdapter
layer
Id
layerId
:
string
Optional
legend
legend
?:
LegendSymbol
[]
legend
Symbols
legendSymbols
:
LegendSymbolsEnum
= 'expand'
resource
Id
resourceId
:
number
Methods
attach
Layer
attachLayer
(
layer
:
LayerAdapter
)
:
void
Parameters
layer
:
LayerAdapter
Returns
void
create
create
(
options
?:
GetRequestOptions
)
:
Promise
<
undefined
|
LegendSymbol
[]
>
Parameters
options
:
GetRequestOptions
= {}
Returns
Promise
<
undefined
|
LegendSymbol
[]
>
create
Legend
createLegend
(
items
:
LegendSymbol
[]
)
:
LegendSymbol
[]
Parameters
items
:
LegendSymbol
[]
Returns
LegendSymbol
[]
set
Legend
Symbol
setLegendSymbol
(
symbolRenderIndexes
:
number
[]
)
:
void
Parameters
symbolRenderIndexes
:
number
[]
Returns
void
set
Symbol
Render
setSymbolRender
(
symbolIndex
:
number
,
status
:
boolean
)
:
void
Parameters
symbolIndex
:
number
status
:
boolean
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
layer
layer
Id
legend
legend
Symbols
resource
Id
Methods
attach
Layer
create
create
Legend
set
Legend
Symbol
set
Symbol
Render
NextGIS Frontend
Loading...
Represents a legend for a specific layer.