Edits Type

The Edits object holds information about which elements of the chart are editable.

Constructors

Constructor Description

Edits()

Full Usage: Edits()

Returns: Edits
Returns: Edits

Static members

Static member Description

Edits.init (?AnnotationPosition, ?AnnotationTail, ?AnnotationText, ?AxisTitleText, ?ColorbarPosition, ?ColorbarTitleText, ?LegendPosition, ?LegendText, ?ShapePosition, ?TitleText)

Full Usage: Edits.init (?AnnotationPosition, ?AnnotationTail, ?AnnotationText, ?AxisTitleText, ?ColorbarPosition, ?ColorbarTitleText, ?LegendPosition, ?LegendText, ?ShapePosition, ?TitleText)

Parameters:
    ?AnnotationPosition : bool - Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).
    ?AnnotationTail : bool - Has only an effect for annotations with arrows. Enables changing the length and direction of the arrow.
    ?AnnotationText : bool - Enables editing annotation text.
    ?AxisTitleText : bool - Enables editing axis title text.
    ?ColorbarPosition : bool - Enables moving colorbars.
    ?ColorbarTitleText : bool - Enables moving colorbars.
    ?LegendPosition : bool - Enables moving colorbars.
    ?LegendText : bool - Enables editing the trace name fields from the legend
    ?ShapePosition : bool - Enables editing the trace name fields from the legend
    ?TitleText : bool - Enables editing the global layout title.

Returns: Edits

Returns a new Edits Object with the given styling.

?AnnotationPosition : bool

Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).

?AnnotationTail : bool

Has only an effect for annotations with arrows. Enables changing the length and direction of the arrow.

?AnnotationText : bool

Enables editing annotation text.

?AxisTitleText : bool

Enables editing axis title text.

?ColorbarPosition : bool

Enables moving colorbars.

?ColorbarTitleText : bool

Enables moving colorbars.

?LegendPosition : bool

Enables moving colorbars.

?LegendText : bool

Enables editing the trace name fields from the legend

?ShapePosition : bool

Enables editing the trace name fields from the legend

?TitleText : bool

Enables editing the global layout title.

Returns: Edits

Edits.style (?AnnotationPosition, ?AnnotationTail, ?AnnotationText, ?AxisTitleText, ?ColorbarPosition, ?ColorbarTitleText, ?LegendPosition, ?LegendText, ?ShapePosition, ?TitleText)

Full Usage: Edits.style (?AnnotationPosition, ?AnnotationTail, ?AnnotationText, ?AxisTitleText, ?ColorbarPosition, ?ColorbarTitleText, ?LegendPosition, ?LegendText, ?ShapePosition, ?TitleText)

Parameters:
    ?AnnotationPosition : bool - Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).
    ?AnnotationTail : bool - Has only an effect for annotations with arrows. Enables changing the length and direction of the arrow.
    ?AnnotationText : bool - Enables editing annotation text.
    ?AxisTitleText : bool - Enables editing axis title text.
    ?ColorbarPosition : bool - Enables moving colorbars.
    ?ColorbarTitleText : bool - Enables moving colorbars.
    ?LegendPosition : bool - Enables moving colorbars.
    ?LegendText : bool - Enables editing the trace name fields from the legend
    ?ShapePosition : bool - Enables editing the trace name fields from the legend
    ?TitleText : bool - Enables editing the global layout title.

Returns: Edits -> Edits

Returns a function that apllioes the given styles to an Edits Object.

?AnnotationPosition : bool

Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).

?AnnotationTail : bool

Has only an effect for annotations with arrows. Enables changing the length and direction of the arrow.

?AnnotationText : bool

Enables editing annotation text.

?AxisTitleText : bool

Enables editing axis title text.

?ColorbarPosition : bool

Enables moving colorbars.

?ColorbarTitleText : bool

Enables moving colorbars.

?LegendPosition : bool

Enables moving colorbars.

?LegendText : bool

Enables editing the trace name fields from the legend

?ShapePosition : bool

Enables editing the trace name fields from the legend

?TitleText : bool

Enables editing the global layout title.

Returns: Edits -> Edits