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 hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

• A named CSS color: see https://plotly.com/python/css-colors/ for a list

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 must be specified as a bool (either 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 hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

• A named CSS color: see https://plotly.com/python/css-colors/ for a list

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 must be specified as a bool (either 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 must be specified as a bool (either 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 hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

• A named CSS color: see https://plotly.com/python/css-colors/ for a list

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 must be specified as a bool (either 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 hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

• A named CSS color: see https://plotly.com/python/css-colors/ for a list

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 must be specified as a bool (either 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 must be specified as a bool (either 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 hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

• A named CSS color: see https://plotly.com/python/css-colors/ for a list

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 must be specified as a bool (either 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 hex string (e.g. ‘#ff0000’)

• An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

• An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

• An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

• A named CSS color: see https://plotly.com/python/css-colors/ for a list

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 must be specified as a bool (either 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 must be specified as a bool (either 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

Subpackages

• plotly.graph_objects.surface.contours.x package
• plotly.graph_objects.surface.contours.y package
• plotly.graph_objects.surface.contours.z package