API / geotoolkit / widgets / overlays / IAnnotation / IAnnotation
overlays.IAnnotation.IAnnotation
Annotation
Interface
Constructors
- [new IAnnotation()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.widgets-1.overlays.iannotation.iannotation.md#new iannotation())
Methods
Methods
▸ Abstract getAnchor(): Point
Get annotation anchor
target
▸ getClassName(): string
string
▸ Abstract getFillStyle(): FillStyle
Return fill style
▸ Abstract getLineStyle(): LineStyle
Return line style
▸ Abstract getName(): string
Get annotation name
string
returns name
▸ Abstract getOptions(): Record<string, any>
Get annotation options
Record<string, any>
options
▸ Abstract getSymbol(): Symbol
Get annotation symbol
▸ Abstract getTarget(): Node
Get annotation target
target
▸ Abstract getText(): string
Get annotation text
string
returns text
▸ Abstract getTextStyle(): TextStyle
Get text style
▸ Abstract getZIndex(): number
Returns node z-index (null if not set)
number
▸ Abstract setAnchor(anchor): IAnnotation
Set annotation anchor Returns annotation
| Name | Type |
|---|---|
anchor | Point |
this
▸ Abstract setFillStyle(fillStyle, merge?): IAnnotation
Sets fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
▸ Abstract setLineStyle(lineStyle, merge?): IAnnotation
Sets line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ Abstract setName(name): IAnnotation
Set annotation name
| Name | Type |
|---|---|
name | string |
this
▸ Abstract setOptions(options): IAnnotation
Set annotation options
| Name | Type |
|---|---|
options | Record<string, any> |
this
▸ Abstract setSymbol(symbol): IAnnotation
Set annotation symbol
| Name | Type | Description |
|---|---|---|
symbol | Symbol | (base64 in case of url) |
this
▸ Abstract setTarget(target): IAnnotation
Set annotation target
| Name | Type |
|---|---|
target | Node |
this
▸ Abstract setText(text): IAnnotation
Set annotation text
| Name | Type |
|---|---|
text | string |
this
▸ Abstract setTextStyle(textStyle, merge?): IAnnotation
Set text style
| Name | Type | Description |
|---|---|---|
textStyle | Type | a new shape text style |
Optional merge | boolean | true if you want to merge textStyle with existing attribute, false by default |
this
▸ Abstract setZIndex(value): IAnnotation
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ Static getClassName(): string
string