Ternary Type

Constructors

Constructor Description

Ternary()

Full Usage: Ternary()

Returns: Ternary
Returns: Ternary

Static members

Static member Description

Ternary.getAAxis ternary

Full Usage: Ternary.getAAxis ternary

Parameters:
    ternary : Ternary - The ternary object to get the a axis from

Returns: LinearAxis

Returns the a axis of the given ternary object. If there is no a axis set, returns an empty LinearAxis object.

ternary : Ternary

The ternary object to get the a axis from

Returns: LinearAxis

Ternary.getBAxis ternary

Full Usage: Ternary.getBAxis ternary

Parameters:
    ternary : Ternary - The ternary object to get the b axis from

Returns: LinearAxis

Returns the b axis of the given ternary object. If there is no b axis set, returns an empty LinearAxis object.

ternary : Ternary

The ternary object to get the b axis from

Returns: LinearAxis

Ternary.getCAxis ternary

Full Usage: Ternary.getCAxis ternary

Parameters:
    ternary : Ternary - The ternary object to get the c axis from

Returns: LinearAxis

Returns the c axis of the given ternary object. If there is no c axis set, returns an empty LinearAxis object.

ternary : Ternary

The ternary object to get the c axis from

Returns: LinearAxis

Ternary.init (?AAxis, ?BAxis, ?CAxis, ?Domain, ?Sum, ?BGColor)

Full Usage: Ternary.init (?AAxis, ?BAxis, ?CAxis, ?Domain, ?Sum, ?BGColor)

Parameters:
    ?AAxis : LinearAxis - Sets the ternary A Axis
    ?BAxis : LinearAxis - Sets the ternary B Axis
    ?CAxis : LinearAxis - Sets the ternary C Axis
    ?Domain : Domain - Sets the ternary domain
    ?Sum : 'b - The number each triplet should sum to, and the maximum range of each axis
    ?BGColor : Color - Sets the background color of the ternary layout.

Returns: Ternary

Initializes a ternary object

?AAxis : LinearAxis

Sets the ternary A Axis

?BAxis : LinearAxis

Sets the ternary B Axis

?CAxis : LinearAxis

Sets the ternary C Axis

?Domain : Domain

Sets the ternary domain

?Sum : 'b

The number each triplet should sum to, and the maximum range of each axis

?BGColor : Color

Sets the background color of the ternary layout.

Returns: Ternary

Ternary.setAAxis aAxis

Full Usage: Ternary.setAAxis aAxis

Parameters:
Returns: Ternary -> Ternary

Returns a function that sets the a axis object of the given ternary object.

aAxis : LinearAxis

The new a axis object

Returns: Ternary -> Ternary

Ternary.setBAxis bAxis

Full Usage: Ternary.setBAxis bAxis

Parameters:
Returns: Ternary -> Ternary

Returns a function that sets the b axis object of the given ternary object.

bAxis : LinearAxis

The new b axis object

Returns: Ternary -> Ternary

Ternary.setCAxis cAxis

Full Usage: Ternary.setCAxis cAxis

Parameters:
Returns: Ternary -> Ternary

Returns a function that sets the c axis object of the given ternary object.

cAxis : LinearAxis

The new c axis object

Returns: Ternary -> Ternary

Ternary.style (?AAxis, ?BAxis, ?CAxis, ?Domain, ?Sum, ?BGColor)

Full Usage: Ternary.style (?AAxis, ?BAxis, ?CAxis, ?Domain, ?Sum, ?BGColor)

Parameters:
    ?AAxis : LinearAxis - Sets the ternary A Axis
    ?BAxis : LinearAxis - Sets the ternary B Axis
    ?CAxis : LinearAxis - Sets the ternary C Axis
    ?Domain : Domain - Sets the ternary domain
    ?Sum : 'a - The number each triplet should sum to, and the maximum range of each axis
    ?BGColor : Color - Sets the background color of the ternary layout.

Returns: Ternary -> Ternary

Creates a function that applies the given style parameters to a Ternary object.

?AAxis : LinearAxis

Sets the ternary A Axis

?BAxis : LinearAxis

Sets the ternary B Axis

?CAxis : LinearAxis

Sets the ternary C Axis

?Domain : Domain

Sets the ternary domain

?Sum : 'a

The number each triplet should sum to, and the maximum range of each axis

?BGColor : Color

Sets the background color of the ternary layout.

Returns: Ternary -> Ternary

Ternary.tryGetTypedMember propName ternary

Full Usage: Ternary.tryGetTypedMember propName ternary

Parameters:
    propName : string - The name of the dynamic member to get the value of
    ternary : Ternary - The object to get the dynamic member value from

Returns: 'T option

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

propName : string

The name of the dynamic member to get the value of

ternary : Ternary

The object to get the dynamic member value from

Returns: 'T option