AnyChart
API Reference
Still have questions?
Contact support
Top

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:

NameTypeDescription
indexnumberIndex to get type.
Setter for type palette HatchFills from list by index.

Params:

NameTypeDescription
indexnumberIndex of hatchFill to set.
typeanychart.graphics.vector.HatchFill.HatchFillType | stringHatchFill type.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.palettes.HatchFills - Self instance for method chaining.
Setter for type palette HatchFills from list by index using patternFill.

Params:

NameTypeDescription
indexnumberIndex of hatchFill to set.
patternFillanychart.graphics.vector.PatternFillPatternFill settings.

Returns:

anychart.palettes.HatchFills - Self instance for method chaining.
Setter for type palette HatchFills from list by index using instance.

Params:

NameTypeDescription
indexnumberIndex of hatchFill to set.
instanceanychart.graphics.vector.HatchFillHatchFill instance.

Returns:

anychart.palettes.HatchFills - Self instance for method chaining.
Enables/disables type palette HatchFills from list by index.

Params:

NameTypeDescription
indexnumberIndex of hatchFill to set.
statebooleanState of hatch fill.

Returns:

anychart.palettes.HatchFills - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.