class anychart.palettes.HatchFills Improve this Doc
Extends: anychart.core.Base
HatchFills palette class.
Methods Overview
| Specific settings | |
| itemAt() | Hatch fill by index. |
| items() | Palette hatch fills list. |
| Events | |
| listen() | Adds an event listener. |
| listenOnce() | Adds a single time event listener. |
| removeAllListeners() | Removes all listeners. |
| unlisten() | Removes the listener. |
| unlistenByKey() | Removes the listener by the key. |
Methods Description
itemAt
Getter for type palette HatchFills from list by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index to get type. |
Returns:
anychart.graphics.vector.HatchFill | anychart.graphics.vector.PatternFill - Marker type by index.Try it:
Setter for type palette HatchFills from list by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of hatchFill to set. |
| type | anychart.graphics.vector.HatchFill.HatchFillType | string | HatchFill type. |
| color | string | Color. |
| thickness | number | Thickness. |
| size | number | Pattern size. |
Returns:
anychart.palettes.HatchFills - Self instance for method chaining.Try it:
Setter for type palette HatchFills from list by index using patternFill.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of hatchFill to set. |
| patternFill | anychart.graphics.vector.PatternFill | PatternFill settings. |
Returns:
anychart.palettes.HatchFills - Self instance for method chaining.Try it:
Setter for type palette HatchFills from list by index using instance.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of hatchFill to set. |
| instance | anychart.graphics.vector.HatchFill | HatchFill instance. |
Returns:
anychart.palettes.HatchFills - Self instance for method chaining.Try it:
Enables/disables type palette HatchFills from list by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of hatchFill to set. |
| state | boolean | State of hatch fill. |
Returns:
anychart.palettes.HatchFills - Self instance for method chaining.Try it:
items
Getter for HatchFills list of palette.
Returns:
Array.<(anychart.graphics.vector.HatchFill|anychart.graphics.vector.HatchFill.HatchFillType|anychart.graphics.vector.PatternFill)> - HatchFills list.Try it:
Setter for HatchFills list of palette.
Params:
| Name | Type | Description |
|---|---|---|
| value | Array.<(anychart.graphics.vector.HatchFill|anychart.graphics.vector.HatchFill.HatchFillType|anychart.graphics.vector.PatternFill)> | HatchFills palette list to set. |
| var_args | anychart.graphics.vector.HatchFill | anychart.graphics.vector.HatchFill.HatchFillType | anychart.graphics.vector.PatternFill | Another types. |
Returns:
anychart.palettes.HatchFills - Self instance for method chaining.listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
}. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
Adds an event listener to an implementing object.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
removeAllListeners
Removes all listeners from an object. You can also optionally remove listeners of some particular type.
Params:
| Name | Type | Description |
|---|---|---|
| type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
Params:
| Name | Type | Description |
|---|---|---|
| key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it: