Skip to main content
Version: v27

Mark

Interface
Types Module: Datafeed

Properties

borderWidth

Optional

Border Width

Type

number


color

Color for the mark

Type

MarkConstColors | MarkCustomColor


hoveredBorderWidth

Optional

Border Width when hovering over bar mark

Type

number


id

ID of the mark

Type

string | number


imageUrl

Optional

Optional URL for an image to be displayed within the timescale mark.

The image should ideally be square in dimension. You can use any image type which the browser supports natively.

Examples:

  • https://yourserver.com/adobe.svg
  • /images/myImage.png
  • data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...
  • data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...

Type

string


label

Label for the mark

Type

string


labelFontColor

Text color for the mark

Type

string


minSize

Minimum size for the mark

Type

number


showLabelWhenImageLoaded

Optional

Continue to show text label even when an image has been loaded for the timescale mark.

Defaults to false if undefined.

Type

boolean


text

Text content for the mark

Type

string


time

Time for the mark. Unix timestamp in seconds.

Type

number