API / geotoolkit / attributes / ClipStyle / ClipStyle
attributes.ClipStyle.ClipStyle
Defines style to be used as model clipping style.
↳
ClipStyle
Constructors
- [new ClipStyle(geometry, evenodd)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.attributes.clipstyle.clipstyle.md#new clipstyle(geometry, evenodd))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
geometry | GraphicsPath | Clipping geometry |
geometry-bounds | Rect | Bounds |
geometry-bounds-height | number | Height |
geometry-bounds-readonly | boolean | Readonly |
geometry-bounds-width | number | Width |
geometry-bounds-x | number | Left |
geometry-bounds-y | number | Top |
Constructors
• new ClipStyle(geometry?, evenodd?)
Create ClipStyle
| Name | Type | Description |
|---|---|---|
Optional geometry | GraphicsPath | Options | clipping geometry or options object |
Optional evenodd | boolean | true if evenodd mode is on ('nonzero' mode otherwise) |
Style.constructor
Methods
▸ clone(): ClipStyle
All inheritors should implement copy constructor or provide custom implementation for this method
this
▸ Protected copyConstructor(src): ClipStyle
copy constructor
| Name | Type | Description |
|---|---|---|
src | ClipStyle | Source to copy from |
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getEvenOdd(): boolean
Returns true if evenodd clipping mode is on
boolean
▸ getGeometry(): GraphicsPath
Gets clipping geometry
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
▸ 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
▸ invalidate(): ClipStyle
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?): ClipStyle
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?): ClipStyle
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: ClipStyle, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): ClipStyle
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: ClipStyle, args: EventMap[E]) => void | to be called |
this
▸ setEvenOdd(bool): ClipStyle
Sets evenodd clipping mode
| Name | Type | Description |
|---|---|---|
bool | boolean | true if evenodd mode is on |
this
▸ setGeometry(geometry): ClipStyle
Sets clipping geometry
| Name | Type | Description |
|---|---|---|
geometry | GraphicsPath | region or area |
▸ setProperties(properties?): ClipStyle
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
▸ setSilent(bool, force?): ClipStyle
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?): ClipStyle
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 fromObject(object?): ClipStyle
Create or get clipping style from object
| Name | Type | Description |
|---|---|---|
Optional object | GraphicsPath | ClipStyle | Options | object can be in format of constructor of ClipStyle |
clipping style
▸ Static getClassName(): string
string
▸ Static isStyleNotificationEnabled(): boolean
Return status of the global notification for all styles.
boolean