API / geotoolkit / controls / shapes / ShapeLegendAdapter / ShapeLegendAdapter
shapes.ShapeLegendAdapter.ShapeLegendAdapter
Abstract class that creates LegendItem elements based on the "shape" state
↳
ShapeLegendAdapter
Constructors
- [new ShapeLegendAdapter(object, legendItemOptions)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.shapes-1.shapelegendadapter.shapelegendadapter.md#new shapelegendadapter(object, legenditemoptions))
Methods
Constructors
• Protected new ShapeLegendAdapter(object?, legendItemOptions?)
Create ShapeLegendAdapter
| Name | Type | Description |
|---|---|---|
Optional object | Group<Node> | an object to tie legend items to |
Optional legendItemOptions | Options | external legend item options |
EventDispatcher.constructor
Methods
▸ Abstract createLegendItems(options?): LegendItem[]
Creates legend items based on its shape's state
| Name | Type | Description |
|---|---|---|
Optional options | Options | legend items' options |
elements
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getLegendItemOptions(): Options
Gets legend item's external options
options
Gets object the adapter and legend items are associated with
object
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
EventDispatcher.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): ShapeLegendAdapter
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | ShapeLegendAdapter | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): ShapeLegendAdapter
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: ShapeLegendAdapter, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): ShapeLegendAdapter
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: ShapeLegendAdapter, args: EventMap[E]) => void | to be called |
this
▸ setLegendItemOptions(options): ShapeLegendAdapter
Sets legend item's external options. Sends Events.LegendItemOptionsChanged event
| Name | Type | Description |
|---|---|---|
options | Options | options |
this
▸ setSilent(bool): ShapeLegendAdapter
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string