class anychart.core.resource.Logo Improve this Doc

Resource Chart Logo element.

Methods Overview

Specific settings
cornerType()	Corner type.
corners()	Corner radius.
overlay()	Overlay element.
Coloring
fill()	Fill settings.
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.
Interactivity
enabled()	Element state (enabled or disabled).
Size and Position
bottom()	Bottom bound setting.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height setting.
left()	Left bound setting.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound setting.
top()	Top bound setting.
width()	Width setting.
zIndex()	Z-index of the element.

Methods Description

bottom

bottom()

Getter for element bottom bound setting.

Returns:

number string undefined - Current element's bottom bound setting.

bottom(value)

Sets element bottom bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Bottom bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.

bounds(value)

Sets bounds of the element using one parameter.

Params:

Name	Type	Description
value	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Usage sample

cornerType

cornerType()

Getter for the corner type.

Returns:

anychart.enums.BackgroundCornersType - Corners type.

Try it:

Usage sample

cornerType(value)

Setter for the corner type.

Detailed description

Note: Set corner radius anychart.core.ui.Background#corners to display a corners shape. If a radius set to 0, no effect will be applied.

Params:

Name	Type	Default	Description
value	anychart.enums.BackgroundCornersType	"round"	Value to set.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Usage sample

corners

corners()

Getter for the corner radius.

Returns:

Array.<number> - Corner settings.

Try it:

Usage sample

corners(value)

Setter for the corner radius by one value.

Detailed description

Note: If array has less than 4 elements(or string provide less than 4 values), the first value is set for all four corners.

Params:

Name	Type	Default	Description
value	number \| string \| Array.<number>	0	Value to set.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

corners(topLeft, topRight, bottomRight, bottomLeft)

Setter for the corner radius by each value.

Params:

Name	Type	Description
topLeft	number \| string	Top left corner value.
topRight	number \| string	Top right corner value.
bottomRight	number \| string	Bottom left corner value.
bottomLeft	number \| string	Bottom right corner value.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

fill

fill()

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill - Fill settings (empty fill is always "none").

Try it:

Usage sample

fill(value)

Setter for fill settings using an object or a string.
Accepts:

or a color as a string, along with opacity, if needed, format is "Color Opacity", e.g. "red 0.5".

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	"#fff"	Fill as an object or a string.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

fill(color, opacity)

Fill as a color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: fill set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Default	Description
color	string	"#fff"	Fill as a string.
opacity	number		Fill opacity.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)

Linear gradient fill.

Detailed description

There are three modes:

ObjectBoundingBox preserving an angle
ObjectBoundingBox no angle preservation
UserSpaceOnUse

Modes:

ObjectBoundingBox preserving an angle
If boolean is passed it says how gradient behaves, specificaly how gradient line angle behaves. If true - it is ObjectBoundingBox with angle preservation. If angle is preserved, in any shape angle looks as one expects it to see.
Note: By default gradient vector for any shape, which sides are not in 1:1 proportions, will not look as expected, because browser transforms this angle.

ObjectBoundingBox no angle preservation
If false is passed - that's ObjectBoundingBox no angle preservation. In this case default behaviour comes up - gradient vector is calculated for a shape with 1:1 side proportions.

UserSpaceOnUse
If anychart.graphics.math.Rect is passed - that'sUserSpaceOnUse mode. In this mode gradient gets its own size and coordinates. Shapes with such gradient will be colored only in those parts, which are covered by this custom gradient. Read more about this mode at gradientUnits. Angle is always preserved in this mode.

Description: a) ObjectBoundingBox no angle preservation.
b) ObjectBoundingBox preserving an angle.
c) UserSpaceOnUse.
d) Three step gradients.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient fill.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Usage sample

getPixelBounds

getPixelBounds()

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

height

height()

Getter for element height setting.

Returns:

number string undefined - Current element's height setting.

height(value)

Sets element height setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Height setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

Usage sample

left

left()

Getter for element left bound setting.

Returns:

number string undefined - Current element's left bound setting.

left(value)

Sets element left bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

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.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

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).

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:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

number string null - Current element's maximum height.

maxHeight(value)

Setter for maximum height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

number string null - Current element's maximum width.

maxWidth(value)

Setter for maximum width.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

number string null - Current element's minimum height.

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

number string null - Current element's minimum width.

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Usage sample

overlay

overlay() Since version 7.12.0

Getter for the overlay element.

Returns:

anychart.core.ui.Overlay - The overlay element

See listing

var element = logo.overlay();

overlay(value) Since version 7.12.0

Setter for the overlay element.

Params:

Name	Type	Description
value	Object \| null \| boolean	Value to set.

Returns:

anychart.core.resource.Logo - Self instance for method chaining.

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

number string undefined - Current element's right bound setting.

right(value)

Sets element right bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

Usage sample

stroke

stroke()

Getter for the background stroke.

Returns:

anychart.graphics.vector.Stroke - Returns stroke.

Try it:

Usage sample

stroke(value)

Setter for stroke settings using one parameter.

Detailed description

Accepts:

String formatted as '[thickness ]color[ opacity]':
1. 'color' - https://www.w3schools.com/html/html_colors.asp.
2. 'thickness color' - like a css border, e.g. '3 red' or '3px red'
3. 'color opacity' - as a fill string, e.g. '#fff 0.5'
4. 'thickness color opacity' - as a complex string, e.g. '3px #00ff00 0.5'
anychart.graphics.vector.Stroke object
anychart.graphics.vector.GradientKey keys array
null resets current stroke settings

Note: String parts order is significant and "3px red" is not the same as "red 3px".

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	"none"	Stroke formatted as "[thickness ]color[ opacity]".

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

stroke(value, thickness, dashpattern, lineJoin, lineCap)

Setter for stroke settings.

Detailed description

Note: When stroke properties are set both by complex stroke object properties and by stroke() method params, object properties have priority. E.g. setting shape.stroke('10 red', 5); (or shape.stroke({color: 'red', thickness: 10}, 5); will result in a red stroke with thickness 10px.

Params:

Name	Type	Description
value	anychart.graphics.vector.Stroke \| string	Stroke settings.
thickness	number	Line thickness. Defaults to 1 of not set.
dashpattern	string	Controls the pattern of dashes and gaps used to stroke paths. Dash array contains a list of white space separated lengths and percentages that specify the lengths of alternating dashes and gaps. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. Thus, stroke dashpattern: "5 3 2" is equivalent to dashpattern: "5 3 2 5 3 2".
lineJoin	anychart.graphics.vector.StrokeLineJoin	Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap	Line cap style.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Usage sample

top

top()

Getter for element top bound setting.

Returns:

number string undefined - Current element's top bound setting.

top(value)

Sets element top bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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.