API / geotoolkit / attributes / Style / Style
attributes.Style.Style
Parent class for all styles
↳
Style↳↳
ClipStyle↳↳
ColoredStyle↳↳
SpaceStyle↳↳
CssStyle↳↳
ElementStyle
Constructors
- [new Style()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.attributes.style.style.md#new style())
Methods
Methods
▸ clone(): Style
All inheritors should implement copy constructor or provide custom implementation for this method
this
▸ Protected copyConstructor(src, deepCopy?): Style
copy constructor
| Name | Type | Description |
|---|---|---|
src | Style | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getProperties(context?): Record<string, any>
Gets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional context | ISerializationContext | serialization context |
Record<string, any>
properties properties
▸ getTimeStamp(): number
Gets time stamp
number
timeStamp
▸ 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
▸ invalidate(): Style
notify the node that the style is invalidated
this
▸ 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?): Style
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | Style | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): Style
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: Style, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): Style
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: Style, args: EventMap[E]) => void | to be called |
this
▸ setProperties(properties?, context?): Style
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Record<string, any> | An object containing the properties to set |
Optional context | IDeserializationContext | deserialization context |
this
▸ setSilent(bool, force?): Style
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
Optional force | boolean | true if parent should be invalidated immediately |
this
▸ updateTimeStamp(silent?): Style
Update time stamp to indicate that style has been changed.
| Name | Type | Description |
|---|---|---|
Optional silent | boolean | silent mode. If this parameter equals to true then style doesn't send invalidate event |
this
▸ Static getClassName(): string
string
▸ Static isStyleNotificationEnabled(): boolean
Return status of the global notification for all styles.
boolean