plotly.graph_objects.surface.contours package¶

class plotly.graph_objects.surface.contours.X(arg=None, color=None, end=None, highlight=None, highlightcolor=None, highlightwidth=None, project=None, show=None, size=None, start=None, usecolormap=None, width=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

Sets the color of the contour lines.

The ‘color’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property end¶

Sets the end contour level value. Must be more than contours.start

The ‘end’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property highlight¶

Determines whether or not contour lines about the x dimension are highlighted on hover.

The ‘highlight’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property highlightcolor¶

Sets the color of the highlighted contour lines.

The ‘highlightcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property highlightwidth¶

Sets the width of the highlighted contour lines.

The ‘highlightwidth’ property is a number and may be specified as:

• An int or float in the interval [1, 16]

Returns

Return type

int|float

property project¶

The ‘project’ property is an instance of Project that may be specified as:

• An instance of plotly.graph_objects.surface.contours.x.Project

• A dict of string/value properties that will be passed to the Project constructor

Returns

Return type

plotly.graph_objects.surface.contours.x.Project

property show¶

Determines whether or not contour lines about the x dimension are drawn.

The ‘show’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property size¶

Sets the step between each contour level. Must be positive.

The ‘size’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property start¶

Sets the starting contour level value. Must be less than contours.end

The ‘start’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property usecolormap¶

An alternate to “color”. Determines whether or not the contour lines are colored using the trace “colorscale”.

The ‘usecolormap’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property width¶

Sets the width of the contour lines.

The ‘width’ property is a number and may be specified as:

• An int or float in the interval [1, 16]

Returns

Return type

int|float

class plotly.graph_objects.surface.contours.Y(arg=None, color=None, end=None, highlight=None, highlightcolor=None, highlightwidth=None, project=None, show=None, size=None, start=None, usecolormap=None, width=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

Sets the color of the contour lines.

The ‘color’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property end¶

Sets the end contour level value. Must be more than contours.start

The ‘end’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property highlight¶

Determines whether or not contour lines about the y dimension are highlighted on hover.

The ‘highlight’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property highlightcolor¶

Sets the color of the highlighted contour lines.

The ‘highlightcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property highlightwidth¶

Sets the width of the highlighted contour lines.

The ‘highlightwidth’ property is a number and may be specified as:

• An int or float in the interval [1, 16]

Returns

Return type

int|float

property project¶

The ‘project’ property is an instance of Project that may be specified as:

• An instance of plotly.graph_objects.surface.contours.y.Project

• A dict of string/value properties that will be passed to the Project constructor

Returns

Return type

plotly.graph_objects.surface.contours.y.Project

property show¶

Determines whether or not contour lines about the y dimension are drawn.

The ‘show’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property size¶

Sets the step between each contour level. Must be positive.

The ‘size’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property start¶

Sets the starting contour level value. Must be less than contours.end

The ‘start’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property usecolormap¶

An alternate to “color”. Determines whether or not the contour lines are colored using the trace “colorscale”.

The ‘usecolormap’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property width¶

Sets the width of the contour lines.

The ‘width’ property is a number and may be specified as:

• An int or float in the interval [1, 16]

Returns

Return type

int|float

class plotly.graph_objects.surface.contours.Z(arg=None, color=None, end=None, highlight=None, highlightcolor=None, highlightwidth=None, project=None, show=None, size=None, start=None, usecolormap=None, width=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

Sets the color of the contour lines.

The ‘color’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property end¶

Sets the end contour level value. Must be more than contours.start

The ‘end’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property highlight¶

Determines whether or not contour lines about the z dimension are highlighted on hover.

The ‘highlight’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property highlightcolor¶

Sets the color of the highlighted contour lines.

The ‘highlightcolor’ property is a color and may be specified as a string in the following formats:

• hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)

• hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)

• rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)

• rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)

• hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)

• hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)

• hwb (e.g. ‘hwb(0 0% 100%)’)

• lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)

• color (e.g. ‘color(display-p3 1 0 0)’)

• named colors (full list: https://www.w3.org/TR/css-color-4/#named-color)

• Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/

Returns

Return type

str

property highlightwidth¶

Sets the width of the highlighted contour lines.

The ‘highlightwidth’ property is a number and may be specified as:

• An int or float in the interval [1, 16]

Returns

Return type

int|float

property project¶

The ‘project’ property is an instance of Project that may be specified as:

• An instance of plotly.graph_objects.surface.contours.z.Project

• A dict of string/value properties that will be passed to the Project constructor

Returns

Return type

plotly.graph_objects.surface.contours.z.Project

property show¶

Determines whether or not contour lines about the z dimension are drawn.

The ‘show’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property size¶

Sets the step between each contour level. Must be positive.

The ‘size’ property is a number and may be specified as:

• An int or float in the interval [0, inf]

Returns

Return type

int|float

property start¶

Sets the starting contour level value. Must be less than contours.end

The ‘start’ property is a number and may be specified as:

• An int or float

Returns

Return type

int|float

property usecolormap¶

An alternate to “color”. Determines whether or not the contour lines are colored using the trace “colorscale”.

The ‘usecolormap’ property is a boolean and must be specified as:

• A boolean value: True or False

Returns

Return type

bool

property width¶

Sets the width of the contour lines.

The ‘width’ property is a number and may be specified as:

• An int or float in the interval [1, 16]

Returns

Return type

int|float