PlotAnnotation()

Examples

julia>

Properties

• align::String -Sets the horizontal alignment of the text within the box. Has an effect only if text spans two or more lines (i.e. text contains one or more <br> HTML tags) or if an explicit width is set to override the text width. Type: enumerated , one of ( "left" | "center" | "right" ) | Default: "center"
• arrowcolor::String -Sets the color of the annotation arrow.
• arrowhead::Int - Sets the end annotation arrow head style. Type: integer between or equal to 0 and 8 | Default: 1
• arrowside::String - Sets the annotation arrow head position. Type: flaglist string. Any combination of "end", "start" joined with a "+" OR "none" | Default: "end"
• arrowsize::Float64 - Sets the size of the end annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line. Type: number greater than or equal to 0.3 | Default: 1
• arrowwidth::Float64 - Sets the width (in px) of annotation arrow line. Type: number greater than or equal to 0.1
• ax::Union{String,Int,Float64} - Sets the x component of the arrow tail about the arrow head. If axref is pixel, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If axref is not pixel and is exactly the same as xref, this is an absolute value on that axis, like x, specified in the same coordinates as xref. Type: number or categorical coordinate string
• axref::String - Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a ax axis id (e.g. "ax" or "ax2"), the ax position refers to a ax coordinate. If set to "paper", the ax position refers to the distance from the left of the plotting area in normalized coordinates where "0" ("1") corresponds to the left (right). If set to a ax axis ID followed by "domain" (separated by a space), the position behaves like for "paper", but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., "ax2 domain" refers to the domain of the second ax axis and a ax position of 0.5 refers to the point between the left and the right of the domain of the second ax axis. In order for absolute positioning of the arrow to work, "axref" must be exactly the same as "xref", otherwise "axref" will revert to "pixel" (explained next). For relative positioning, "axref" can be set to "pixel", in which case the "ax" value is specified in pixels relative to "x". Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point. Type: enumerated , one of ( "pixel" | "/^x([2-9]|[1-9][0-9]+)?( domain)?$/") | Default: "pixel"
• ay::Union{String,Int,Float64} - Sets the y component of the arrow tail about the arrow head. If ayref is pixel, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If ayref is not pixel and is exactly the same as yref, this is an absolute value on that axis, like y, specified in the same coordinates as yref. Type: number or categorical coordinate string
• ayref::String - Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a ay axis id (e.g. "ay" or "ay2"), the ay position refers to a ay coordinate. If set to "paper", the ay position refers to the distance from the bottom of the plotting area in normalized coordinates where "0" ("1") corresponds to the bottom (top). If set to a ay axis ID followed by "domain" (separated by a space), the position behaves like for "paper", but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., "ay2 domain" refers to the domain of the second ay axis and a ay position of 0.5 refers to the point between the bottom and the top of the domain of the second ay axis. In order for absolute positioning of the arrow to work, "ayref" must be exactly the same as "yref", otherwise "ayref" will revert to "pixel" (explained next). For relative positioning, "ayref" can be set to "pixel", in which case the "ay" value is specified in pixels relative to "y". Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point. Type: enumerated , one of ( "pixel" | "/^x([2-9]|[1-9][0-9]+)?( domain)?$/") | Default: "pixel"
• bgcolor::String -Sets the background color of the annotation. Default: "rgba(0,0,0,0)"
• bordercolor::String - Sets the color of the border enclosing the annotation text. Default: "rgba(0,0,0,0)"
• borderpad::Int - Sets the padding (in px) between the text and the enclosing border. Default: 1
• borderwidth::Int - Sets the width (in px) of the border enclosing the annotation text. Type: number greater than or equal to 0 | Default: 1
• captureevents::Bool - Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default captureevents is "false" unless hovertext is provided. If you use the event plotly_clickannotation without hovertext you must explicitly enable captureevents.
• font::Font - Sets the annotation text font.
• height::Int - Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped. Type: number greater than or equal to 1
• hoverlabel::Dict - object containing one or more of the keys listed: bgcolor bordercolor font
• name::String - When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.
• opacity::Float64 - Sets the opacity of the annotation (text + arrow). Type: number between or equal to 0 and 1 | Default: 1
• showarrow::Bool - Determines whether or not the annotation is drawn with an arrow. If "true", text is placed near the arrow's tail. If "false", text lines up with the x and y provided. Default: true
• standoff::Int - Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount. Type: number greater than or equal to 0 | Default: 0
• startarrowhead::Int - Sets the start annotation arrow head style. Type: integer between or equal to 0 and 8 | Default: 1
• startarrowsize::Int - Sets the size of the start annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line. Type: number greater than or equal to 0.3 | Default: 1
• startstandoff::Int - Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount. Type: number greater than or equal to 0 | Default: 0
• templateitemname::String - Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.
• text::String - Sets the text associated with the annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported. Type: string
• textangle::Union{Int,Float64} - Sets the angle at which the text is drawn with respect to the horizontal. Type: angle | Default: 0
• valign::String - Sets the vertical alignment of the text within the box. Has an effect only if an explicit height is set to override the text height. Type: enumerated , one of ( "top" | "middle" | "bottom") | Default: "middle"
• visible::Bool visible - Determines whether or not this annotation is visible. Type: boolean | Default: true
• width::Int - Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. Type: number greater than or equal to 1
• x::Union{String,Int,Float64} - Sets the annotation's x position. If the axis type is "log", then you must take the log of your desired range. If the axis type is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
• xanchor::String - Sets the text box's horizontal position anchor This anchor binds the x position to the "left", "center" or "right" of the annotation. For example, if x is set to 1, xref to "paper" and xanchor to "right" then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If "auto", the anchor is equivalent to "center" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side. Type: enumerated , one of ( "auto" | "left" | "center" | "right") | Default: "auto"
• xref::Union{String,Int,Float64} - Sets the annotation's x coordinate axis. If set to a x axis id (e.g. "x" or "x2"), the x position refers to a x coordinate. If set to "paper", the x position refers to the distance from the left of the plotting area in normalized coordinates where "0" ("1") corresponds to the left (right). If set to a x axis ID followed by "domain" (separated by a space), the position behaves like for "paper", but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., "x2 domain" refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. Type: enumerated , one of ( "paper" | "/^x([2-9]|[1-9][0-9]+)?( domain)?$/" )
• xshift::Union{Int,Float64} - Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels. Default: 0
• y::Union{String,Int,Float64} - Sets the annotation's y position. If the axis type is "log", then you must take the log of your desired range. If the axis type is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
• yanchor::Union{String} - Sets the text box's vertical position anchor This anchor binds the y position to the "top", "middle" or "bottom" of the annotation. For example, if y is set to 1, yref to "paper" and yanchor to "top" then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If "auto", the anchor is equivalent to "middle" for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side. Type: enumerated , one of ( "auto" | "top" | "middle" | "bottom") | Default: "auto"
• yref::Union{String,Int,Float64} - Sets the annotation's y coordinate axis. If set to a y axis id (e.g. "y" or "y2"), the y position refers to a y coordinate. If set to "paper", the y position refers to the distance from the bottom of the plotting area in normalized coordinates where "0" ("1") corresponds to the bottom (top). If set to a y axis ID followed by "domain" (separated by a space), the position behaves like for "paper", but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., "y2 domain" refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. Type: enumerated , one of ( "paper" | "/^x([2-9]|[1-9][0-9]+)?( domain)?$/" )
• yshift::Union{Int,Float64} - Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels. Default: 0

source

PlotAnnotation()

Examples

julia>

Properties

• anchor::String - If set to an opposite-letter axis id (e.g. x2, y), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by position. Type: enumerated , one of ( "free" | "/^x([2-9]|[1-9][0-9]+)?( domain)?$/" |"/^y([2-9]|[1-9][0-9]+)?( domain)?$/" )
• automargin::Bool - Determines whether this axis' margin is computed automatically. Type: boolean
• autorange::Bool - Determines whether or not the range of this axis is computed in relation to the input data. See rangemode for more info. If range is provided, then autorange is set to "false". Type: enumerated , one of ( true | false | "reversed" ) | Default: true
• autotypenumbers::String - Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis type detection. Defaults to layout.autotypenumbers. Type: enumerated , one of ( "strict" | "convert types" ) | Default: "convert types"
• calendar::String - Sets the calendar system to use for range and tick0 if this is a date axis. This does not set the calendar for interpreting data on this axis, that's specified in the trace or via the global layout.calendar. Type: enumerated , one of ( "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura" ) | Default: "gregorian"
• categoryarray::Vector{Float64} - Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to "array". Used with categoryorder. Type: Vector
• categoryorder::String - Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set categoryorder to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set categoryorder to "array" to derive the ordering from the attribute categoryarray. If a category is not found in the categoryarray array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in categoryarray. Set categoryorder to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values. Type: enumerated , one of ( "trace" | "category ascending" | "category descending" | "array" | "total ascending" | "total descending" ) | Default: "trace"
• constrain::String - If this axis needs to be compressed (either due to its own scaleanchor and scaleratio or those of the other axis), determines how that happens: by increasing the "range", or by decreasing the "domain". Default is "domain" for axes containing image traces, "range" otherwise. Type: enumerated , one of ( "domain" | "range" )
• constraintoward::String - If this axis needs to be compressed (either due to its own scaleanchor and scaleratio or those of the other axis), determines which direction we push the originally specified plot area. Options are "left", "center" (default), and "right" for x axes, and "top", "middle" (default), and "bottom" for y axes. Type: enumerated , one of ( "left" | "center" | "right" | "top" | "middle" | "bottom" )
• dividercolor::String - Sets the color of the dividers Only has an effect on "multicategory" axes. Type: color | Default: "#444"
• dividerwidth::Float - Sets the width (in px) of the dividers Only has an effect on "multicategory" axes. Type: float | Default: 1
• domain::Vector{Float64} - Sets the domain of this axis (in plot fraction). Type: Vector
• dtick::Union{Float64,Int,String} - Sets the step in-between ticks on this axis. Use with tick0. Must be a positive number, or special strings available to "log" and "date" axes. If the axis type is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). tick0 is ignored for "D1" and "D2". If the axis type is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to "2000-01-15" and dtick to "M3". To set ticks every 4 years, set dtick to "M48"
• fixedrange::Bool - Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
• font::Font - Check Font structure for signature.
• gridcolor::String - Sets the color of the grid lines. Type: color | Default: "#eee"
• gridwidth::Int - Sets the width (in px) of the grid lines. Type: float | Default: 1
• hoverformat::String - Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "091523.46". Default: ""
• layer::String - Sets the layer on which this axis is displayed. If "above traces", this axis is displayed above all the subplot's traces If "below traces", this axis is displayed below all the subplot's traces, but above the grid lines. Useful when used together with scatter-like traces with cliponaxis set to "false" to show markers and/or text nodes above this axis. Type: enumerated , one of ( "above traces" | "below traces" ) | Default: "above traces"
• linecolor::String - Sets the axis line color. Type: color | Default: "#444"
• linewidth::Int - Sets the width (in px) of the axis line. Type: float | Default: 1
• minexponent::Int - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is "SI" or "B". Type: number greater than or equal to 0 | Default: 3
• mirror::Union{Bool,String} - Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored. If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots. Type: enumerated , one of (true|"ticks"|false|"all"|"allticks")
• nticks::Int - Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to "auto". Type: number greater than or equal to 0 | Default: 0
• overlaying::String - If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible. Type: enumerated , one of ( "free" | "/^x([2-9]|[1-9][0-9]+)?( domain)?$/" | "/^y([2-9]|[1-9][0-9]+)?( domain)?$/" )
• position::Float64 - Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to "free". Type: number between or equal to 0 and 1 | Default: 0
• range::Union{Vector{Int},Vector{Float64}} - Sets the range of this axis. If the axis type is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis type is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.
• rangemode::String - If "normal", the range is computed in relation to the extrema of the input data. If "tozero", the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. Applies only to linear axes. Type: enumerated , one of ("normal"|"tozero"|"nonnegative") | Default:"normal"`
• scaleanchor::String - If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: "x"}, xaxis2: {scaleanchor: "y"} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: "x"}, xaxis: {scaleanchor: "y"} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Type: enumerated , one of ( "/^x([2-9]|[1-9][0-9]+)?( domain)?$/" | "/^y([2-9]|[1-9][0-9]+)?( domain)?$/" )
• scaleratio::Int - If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal. Type: number greater than or equal to 0 | Default: 1
• showdividers::Bool - Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes. Type: boolean | Default: true
• showexponent::String - If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear. Type: enumerated , one of ( "all" | "first" | "last" | "none" ) | Default: "all"
• showgrid::Bool - Determines whether or not grid lines are drawn. If True, the grid lines are drawn at every tick mark. Type: boolean | Default: true
• showline::Bool - Determines whether or not a line bounding this axis is drawn. Type: boolean
• showspikes::Bool - Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest. Type: boolean
• showticklabels::Bool - Determines whether or not the tick labels are drawn.
• side::String - Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area. Type: enumerated , one of ( "top" | "bottom" | "left" | "right" ) | Default: "bottom"
• spikecolor::String - Sets the spike color. If undefined, will use the series color
• spikedash::String - Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
• spikemode::String - Determines the drawing mode for the spike line If "toaxis", the line is drawn from the data point to the axis the series is plotted on. If "across", the line is drawn across the entire plot area, and supercedes "toaxis". If "marker", then a marker dot is drawn on the axis the series is plotted on. Type: Any combination of "toaxis", "across", "marker" joined with a "+" | Examples. "toaxis" | "across" | "marker" | "toaxis+across" | "toaxis+marker" | "across+marker" | "toaxis+across+marker" | Default: "toaxis"
• spikesnap::String - Determines whether spikelines are stuck to the cursor or to the closest datapoints. Type: enumerated , one of ( "data" | "cursor" | "hovered data") | Default: "hovered data"
• spikethickness::Int - Sets the width (in px) of the zero line. Default: 3
• tick0::Union{Float64,Int,String} - Sets the placement of the first tick on this axis. Use with dtick. If the axis type is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick="L<f>" (see dtick for more info). If the axis type is "date", it should be a date string, like date data. If the axis type is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
• tickangle::Union{String,Int,Float64} - Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically. Default: "auto"
• tickcolor::String - Sets the tick color. Default: "#444"
• tickformat::String - Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "091523.46". Default: ""
• ticklabelmode::String - Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type "date" When set to "period", tick labels are drawn in the middle of the period between ticks. Type: enumerated , one of ( "instant" | "period" ) | Default: "instant"
• ticklabeloverflow::String - Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". Otherwise on "category" and "multicategory" axes the default is "allow". In other cases the default is "hide past div". Type: enumerated , one of ( "allow" |"hide past div" | "hide past domain" )
• ticklabelposition::String - Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to "period". Similarly left or right has no effect on y axes or when ticklabelmode is set to "period". Has no effect on "multicategory" axes or when tickson is set to "boundaries". When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match. Type: enumerated , one of ( "top" | "bottom" | "left" | "right" | "outsideleft" | "insideleft" ) | Default: "outside"
• ticklen::Int - Sets the tick length (in px). Default: 5
• tickmode::String - Sets the tick mode for this axis. If "auto", the number of ticks is set via nticks. If "linear", the placement of the ticks is determined by a starting position tick0 and a tick step dtick ("linear" is the default value if tick0 and dtick are provided). If "array", the placement of the ticks is set via tickvals and the tick text is ticktext. ("array" is the default value if tickvals is provided). Type: enumerated , one of ( "auto" | "linear" | "array" )
• tickprefix::String - Sets a tick label prefix. Default: ""
• ticks::String - Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
• tickson::String - Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type "category" or "multicategory". When set to "boundaries", ticks and grid lines are drawn half a category to the left/bottom of labels. Type: enumerated , one of ("labels" | "boundaries" ) | Default: "labels"
• ticksuffix::String - Sets a tick label suffix. Default: ""
• ticktext::Vector{String} - Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to "array". Used with tickvals.
• tickvals::Union{Vector{Float64},Vector{Int}} - Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to "array". Used with ticktext.
• tickwidth::Int - Sets the tick width (in px). Type: number greater than or equal to 0 | Default: 1
• title::String - Sets the title of this axis.
• type::String - Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question. Type: enumerated , one of ( "-" | "linear" | "log" | "date" | "category" | "multicategory" ) | Default: "-"
• visible::Bool - A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false
• zeroline::Bool - Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.
• zerolinecolor::String - Sets the line color of the zero line. Default: #444
• zerolinewidth::Int - Sets the width (in px) of the zero line. Default: 1

Important

• xy::String - Sets a reference to the x or y axis. If "x", the x axis will be matched. If "y", the y axis will be matched.
• index::Int - 1 # 1, 2, 3 etc. for subplots
• title_text::String - Sets the text of the title of this axis.
• title_font::Font - Sets the title font.
• title_standoff:Int - Sets the standoff distance between the axis title and the axis labels, in pixels.

source

PlotLayoutGeo()

Examples

julia>

Properties

• bgcolor::String - Set the background color of the map. Type: color | Default: "#fff"
• center::Mcenter - Check Mcenter documentation for details.
• coastlinecolor::String - Set the coastline color. Type: color | Default: "#444"
• coastlinewidth::Int - Set the coastline width. Type: number | Default: 1
• countrywidth::Int - Sets line color of the country boundaries. Type: number greater than or equal to 0 | Default: 1
• fitbounds::Bool - Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting fitbounds leads to center.lon and center.lat getting auto-filled. On maps with a non-clipped projection, setting fitbounds leads to center.lon, center.lat, and projection.rotation.lon getting auto-filled. On maps with a clipped projection, setting fitbounds leads to center.lon, center.lat, projection.rotation.lon, projection.rotation.lat, lonaxis.range and lonaxis.range getting auto-filled. If "locations", only the trace's visible locations are considered in the fitbounds computations. If "geojson", the entire trace input geojson (if provided) is considered in the fitbounds computations, Defaults to "false". Type: enumerated , one of ( false | "locations" | "geojson" )
• framecolor::String - Set the frame color. Type: color | Default: "#444"
• framewidth::Int - Sets the stroke width (in px) of the frame. Type: number greater than or equal to 0 | Default: 1
• lakecolor::String - Set the color of the lakes. Type: color | Default: "#3399FF"
• landcolor::String - Sets the land mass color. Type: color | Default: "#F0DC82"
• lataxis::PlotLayoutAxis - Check PlotLayoutAxis documentation for details.
• lonaxis::PlotLayoutAxis - Check PlotLayoutAxis documentation for details.
• oceancolor::String - Sets the ocean color. Type: color | Default: "#3399FF"
• geoprojection::GeoProjection - Check GeoProjection documentation for details.
• resolution::String - Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000. Type: enumerated , one of ( "110" | "50" ) | Default: "110"
• rivercolor::String - Sets color of the rivers. Type: color | Default: "#3399FF"
• riverwidth::Int - Sets the stroke width (in px) of the rivers. Type: number greater than or equal to 0 | Default: 1
• scope::String - Sets the scope of the map. Type: enumerated , one of ( "world" | "usa" | "europe" | "asia" | "africa" | "north america" | "south america" ) | Default: "world"
• showcoastlines::Bool - Sets whether or not the coastlines are drawn.
• showcountries::Bool - Sets whether or not country boundaries are drawn.
• showframe::Bool - Sets whether or not a frame is drawn around the map.
• showlakes::Bool - Sets whether or not lakes are drawn.
• showland::Bool - Sets whether or not land masses are filled in color.
• showocean::Bool - Sets whether or not oceans are filled in color.
• showrivers::Bool - Sets whether or not rivers are drawn.
• showsubunits::Bool - Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.
• subunitcolor::String - Sets the color of the subunits boundaries. Type: color | Default: "#444"
• subunitwidth::Int - Sets the stroke width (in px) of the subunits boundaries. Type: number greater than or equal to 0 | Default: 1
• uirevision::Union{String,Int} - Controls persistence of user-driven changes in the view (projection and center). Defaults to layout.uirevision. Type: number or categorical coordinate string
• visible::Bool - Sets the default visibility of the base layers. Default: true

source

PlotLayoutGrid()

Examples

julia>

Properties

• columns::String - The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. Type: integer greater than or equal to 1
• domain_x::Vector{Float64} - Sets the horizontal domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. Default: [0, 1]
• domain_y::Vector{Float64} - Sets the vertical domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. Default: [0, 1]
• pattern::String - If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder. Type: one of "coupled" or "independent" | Default. "coupled"
• roworder::String - Is the first row the top or the bottom? Note that columns are always enumerated from left to right. enumerated , one of ( "top to bottom" | "bottom to top" ) | Default: "top to bottom"
• rows::Int - The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots. Type: integer greater than or equal to 1
• subplots::Matrix{String} - Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute.
• xaxes::Vector{String} - Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs.
• xgap::Float64 - Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids. Type: number between or equal to 0 and 1
• xside::String - Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar. Type: enumerated , one of ( "bottom" | "bottom plot" | "top plot" | "top" ) | Default: "bottom plot"
• yaxes::Vector{String} - Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs.
• ygap::Float64 - Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids. Type: number between or equal to 0 and 1
• yside::String - Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar. Type: enumerated , one of ( "left" | "left plot" | "right plot" | "right" ) | Default: "left plot"

source