Header menu logo Plotly.NET

NewShape Type

Namespace: Plotly.NET.LayoutObjects
Assembly: Plotly.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

Constructors

Constructor Description

NewShape()

Full Usage: NewShape()

Returns: NewShape
Returns: NewShape

Static members

Static member Description

NewShape.getLegendAnchor newShape

Full Usage: NewShape.getLegendAnchor newShape

Parameters:
    newShape : NewShape - The NewShape to get the Legend anchor from

Returns: SubPlotId

Returns the Legend anchor of the given NewShape. If there is no Legend set, returns "legend".

newShape : NewShape

The NewShape to get the Legend anchor from

Returns: SubPlotId

NewShape.init (?DrawDirection, ?FillColor, ?FillRule, ?Layer, ?ShowLegend, ?Legend, ?LegendRank, ?LegendGroup, ?LegendGroupTitle, ?LegendWidth, ?Line, ?Name, ?Opacity, ?Visible)

Full Usage: NewShape.init (?DrawDirection, ?FillColor, ?FillRule, ?Layer, ?ShowLegend, ?Legend, ?LegendRank, ?LegendGroup, ?LegendGroupTitle, ?LegendWidth, ?Line, ?Name, ?Opacity, ?Visible)

Parameters:
    ?DrawDirection : DrawDirection - When `dragmode` is set to "drawrect", "drawline" or "drawcircle" this limits the drag to be horizontal, vertical or diagonal. Using "diagonal" there is no limit e.g. in drawing lines in any direction. "ortho" limits the draw to be either horizontal or vertical. "horizontal" allows horizontal extend. "vertical" allows vertical extend.
    ?FillColor : Color - Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.
    ?FillRule : FillRule - Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule
    ?Layer : Layer - Specifies whether new shapes are drawn below or above traces.
    ?ShowLegend : bool - Determines whether or not an item corresponding to this shape is shown in the legend.
    ?Legend : SubPlotId - Sets the reference to a legend to show this shape in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.
    ?LegendRank : int - Sets the legend rank for this shape. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.
    ?LegendGroup : string - Sets the legend group for this shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
    ?LegendGroupTitle : Title - Sets the legend group title for this shape.
    ?LegendWidth : float - Sets the width (in px or fraction) of the legend for this shape.
    ?Line : Line - Sets the outline of new shapes.
    ?Name : string - Sets new shape name. The name appears as the legend item.
    ?Opacity : float - Sets the opacity of new shapes.
    ?Visible : Visible - Determines whether or not new shape is visible. If "legendonly", the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Returns: NewShape

Returns a new NewShape object with the given styling.

?DrawDirection : DrawDirection

When `dragmode` is set to "drawrect", "drawline" or "drawcircle" this limits the drag to be horizontal, vertical or diagonal. Using "diagonal" there is no limit e.g. in drawing lines in any direction. "ortho" limits the draw to be either horizontal or vertical. "horizontal" allows horizontal extend. "vertical" allows vertical extend.

?FillColor : Color

Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.

?FillRule : FillRule

Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule

?Layer : Layer

Specifies whether new shapes are drawn below or above traces.

?ShowLegend : bool

Determines whether or not an item corresponding to this shape is shown in the legend.

?Legend : SubPlotId

Sets the reference to a legend to show this shape in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.

?LegendRank : int

Sets the legend rank for this shape. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

?LegendGroup : string

Sets the legend group for this shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

?LegendGroupTitle : Title

Sets the legend group title for this shape.

?LegendWidth : float

Sets the width (in px or fraction) of the legend for this shape.

?Line : Line

Sets the outline of new shapes.

?Name : string

Sets new shape name. The name appears as the legend item.

?Opacity : float

Sets the opacity of new shapes.

?Visible : Visible

Determines whether or not new shape is visible. If "legendonly", the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Returns: NewShape

NewShape.setLegendAnchor legendId

Full Usage: NewShape.setLegendAnchor legendId

Parameters:
    legendId : int - The new Legend anchor

Returns: NewShape -> NewShape

Returns a function that sets the Legend anchor of the given NewShape.

legendId : int

The new Legend anchor

Returns: NewShape -> NewShape

NewShape.style (?DrawDirection, ?FillColor, ?FillRule, ?Layer, ?ShowLegend, ?Legend, ?LegendRank, ?LegendGroup, ?LegendGroupTitle, ?LegendWidth, ?Line, ?Name, ?Opacity, ?Visible)

Full Usage: NewShape.style (?DrawDirection, ?FillColor, ?FillRule, ?Layer, ?ShowLegend, ?Legend, ?LegendRank, ?LegendGroup, ?LegendGroupTitle, ?LegendWidth, ?Line, ?Name, ?Opacity, ?Visible)

Parameters:
    ?DrawDirection : DrawDirection - When `dragmode` is set to "drawrect", "drawline" or "drawcircle" this limits the drag to be horizontal, vertical or diagonal. Using "diagonal" there is no limit e.g. in drawing lines in any direction. "ortho" limits the draw to be either horizontal or vertical. "horizontal" allows horizontal extend. "vertical" allows vertical extend.
    ?FillColor : Color - Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.
    ?FillRule : FillRule - Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule
    ?Layer : Layer - Specifies whether new shapes are drawn below or above traces.
    ?ShowLegend : bool - Determines whether or not an item corresponding to this shape is shown in the legend.
    ?Legend : SubPlotId - Sets the reference to a legend to show this shape in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.
    ?LegendRank : int - Sets the legend rank for this shape. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.
    ?LegendGroup : string - Sets the legend group for this shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
    ?LegendGroupTitle : Title - Sets the legend group title for this shape.
    ?LegendWidth : float - Sets the width (in px or fraction) of the legend for this shape.
    ?Line : Line - Sets the outline of new shapes.
    ?Name : string - Sets new shape name. The name appears as the legend item.
    ?Opacity : float - Sets the opacity of new shapes.
    ?Visible : Visible - Determines whether or not new shape is visible. If "legendonly", the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Returns: NewShape -> NewShape

Returns a function that applies the given styles to a NewShape object

?DrawDirection : DrawDirection

When `dragmode` is set to "drawrect", "drawline" or "drawcircle" this limits the drag to be horizontal, vertical or diagonal. Using "diagonal" there is no limit e.g. in drawing lines in any direction. "ortho" limits the draw to be either horizontal or vertical. "horizontal" allows horizontal extend. "vertical" allows vertical extend.

?FillColor : Color

Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.

?FillRule : FillRule

Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule

?Layer : Layer

Specifies whether new shapes are drawn below or above traces.

?ShowLegend : bool

Determines whether or not an item corresponding to this shape is shown in the legend.

?Legend : SubPlotId

Sets the reference to a legend to show this shape in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.

?LegendRank : int

Sets the legend rank for this shape. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

?LegendGroup : string

Sets the legend group for this shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

?LegendGroupTitle : Title

Sets the legend group title for this shape.

?LegendWidth : float

Sets the width (in px or fraction) of the legend for this shape.

?Line : Line

Sets the outline of new shapes.

?Name : string

Sets new shape name. The name appears as the legend item.

?Opacity : float

Sets the opacity of new shapes.

?Visible : Visible

Determines whether or not new shape is visible. If "legendonly", the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Returns: NewShape -> NewShape

NewShape.tryGetTypedMember propName newShape

Full Usage: NewShape.tryGetTypedMember propName newShape

Parameters:
    propName : string - The name of the dynamic member to get the value of
    newShape : NewShape - The NewShape to get the dynamic member value from

Returns: 'T option

Returns Some(dynamic member value) of the NewShape object's underlying DynamicObj when a dynamic member with the given name exists, and None otherwise.

propName : string

The name of the dynamic member to get the value of

newShape : NewShape

The NewShape to get the dynamic member value from

Returns: 'T option

Type something to start searching.