class anychart.core.axes.MapSettings Improve this Doc
Extends: anychart.core.VisualBase
Map axes settings class.
Methods Overview
| Specific settings | |
| enabled() | Disable or enable axis. |
| minorTicks() | Minor ticks settings. |
| overlapMode() | Overlap mode for labels. |
| ticks() | Ticks settings. |
| title() | Title settings. |
| Axes and Scales | |
| bottom() | Bottom axis settings. |
| left() | Left axis settings. |
| right() | Right axis settings. |
| top() | Top axis settings. |
| Coloring | |
| stroke() | Stroke settings. |
| 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. |
| Export | |
| print() | Prints all elements. |
| Labels | |
| drawFirstLabel() | Drawing of the first label. |
| drawLastLabel() | Drawing of the last label. |
| labels() | Labels settings. |
| minorLabels() | Minor labels settings. |
| Size and Position | |
| zIndex() | Z-index of the element. |
Methods Description
bottom
Setter for the bottom axis.
Detailed description
Sets bottom axis settings depending on parameter type:
- null/boolean - disable or enable bottom axis.
- object - sets bottom axis settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Object | Settings for axis. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.drawFirstLabel
Getter for the first label drawing flag.
Returns:
boolean - Drawing flag.Setter for the first label drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.Try it:
drawLastLabel
Getter for the last label drawing flag.
Returns:
boolean - Drawing flag.Setter for the last label drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.Try it:
enabled
Getter for the axis enabled state.
Returns:
boolean - Axis enabled state.Setter for the axis enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.Try it:
labels
Setter for axis labels.
Detailed description
Sets axis labels settings depending on parameter type:
- null/boolean - disable or enable axis labels.
- object - sets axis labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | true | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.left
Setter for the left axis.
Detailed description
Sets left axis settings depending on parameter type:
- null/boolean - disable or enable left axis.
- object - sets left axis settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Object | Settings for axis. |
Returns:
anychart.core.axes.MapSettings - 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:
minorLabels
Setter for axis minor labels.
Detailed description
Sets axis minor labels settings depending on parameter type:
- null/boolean - disable or enable axis minor labels.
- object - sets axis minor labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.minorTicks
Setter for minor axis ticks.
Detailed description
Sets axis minor ticks settings depending on parameter type:
- null/boolean - disable or enable axis minor ticks.
- object - sets axis minor ticks settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.overlapMode
Getter for labels overlap mode.
Returns:
anychart.enums.LabelsOverlapMode - Overlap mode.Setter for labels overlap mode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.LabelsOverlapMode | string | "noOverlap" | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.Try it:
Prints all elements on related stage.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
| landscape | boolean | false | Flag of landscape. |
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:
right
Setter for the right axis.
Detailed description
Sets right axis settings depending on parameter type:
- null/boolean - disable or enable right axis.
- object - sets right axis settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Object | Settings for axis. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.stroke
Getter for axis stroke settings.
Returns:
anychart.graphics.vector.Stroke - Axis stroke settings.Setter for axis stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | "#eaeaea" | Stroke settings. |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | 'round' | Line join style. |
| lineCap | anychart.graphics.vector.StrokeLineCap | 'square' | Line cap style. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.Try it:
ticks
Setter for axis ticks.
Detailed description
Sets axis ticks settings depending on parameter type:
- null/boolean - disable or enable axis ticks.
- object - sets axis ticks settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | true | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.title
Setter for the axis title.
Detailed description
Sets axis title settings depending on parameter type:
- null/boolean - disable or enable axis title.
- string - sets axis title text value.
- object - sets axis title settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | Object | string | false | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.top
Setter for the top axis.
Detailed description
Sets top axis settings depending on parameter type:
- null/boolean - disable or enable top axis.
- object - sets top axis settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Object | Settings for axis. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.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:
zIndex
Getter for the current Z-index of the element.
Returns:
number - The current zIndex.Try it:
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.core.axes.MapSettings - Self instance for method chaining.Try it: