Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
altavir committed Jul 29, 2023
1 parent 4952b41 commit 385dc05
Show file tree
Hide file tree
Showing 9 changed files with 76 additions and 19 deletions.
11 changes: 9 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased

### Added
- Add experimental support for events on JS

### Changed
- Use a self-made Plotly-js bundle instead of one from CDN

### Deprecated

Expand All @@ -20,6 +18,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Security

## 0.6.0 - 2023-07-29

### Added
- Add experimental support for events on JS

### Changed
- DataForge 0.6.2
- Use a self-made Plotly-js bundle instead of one from CDN

## 0.5.3 - 2023-04-01

### Added
Expand Down
4 changes: 2 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ plugins {
id("space.kscience.gradle.project")
}

val dataforgeVersion by extra("0.6.2-dev-2")
val dataforgeVersion by extra("0.6.2")
val plotlyVersion by extra("2.24.1")

allprojects {
group = "space.kscience"
version = "0.6.0-dev-2"
version = "0.6.0"
}

apiValidation {
Expand Down
6 changes: 3 additions & 3 deletions plotlykt-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Artifact:

The Maven coordinates of this project are `space.kscience:plotlykt-core:0.5.3`.
The Maven coordinates of this project are `space.kscience:plotlykt-core:0.6.0`.

**Gradle Groovy:**
```groovy
Expand All @@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:plotlykt-core:0.5.3'
implementation 'space.kscience:plotlykt-core:0.6.0'
}
```
**Gradle Kotlin DSL:**
Expand All @@ -27,6 +27,6 @@ repositories {
}

dependencies {
implementation("space.kscience:plotlykt-core:0.5.3")
implementation("space.kscience:plotlykt-core:0.6.0")
}
```
44 changes: 44 additions & 0 deletions plotlykt-core/api/plotlykt-core.api
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,48 @@ public abstract interface annotation class space/kscience/plotly/UnstablePlotlyA
public abstract interface annotation class space/kscience/plotly/UnsupportedPlotlyAPI : java/lang/annotation/Annotation {
}

public final class space/kscience/plotly/events/PlotlyEvent {
public fun <init> (Ljava/util/List;)V
public final fun component1 ()Ljava/util/List;
public final fun copy (Ljava/util/List;)Lspace/kscience/plotly/events/PlotlyEvent;
public static synthetic fun copy$default (Lspace/kscience/plotly/events/PlotlyEvent;Ljava/util/List;ILjava/lang/Object;)Lspace/kscience/plotly/events/PlotlyEvent;
public fun equals (Ljava/lang/Object;)Z
public final fun getPoints ()Ljava/util/List;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class space/kscience/plotly/events/PlotlyEventListenerType : java/lang/Enum {
public static final field CLICK Lspace/kscience/plotly/events/PlotlyEventListenerType;
public static final field HOVER Lspace/kscience/plotly/events/PlotlyEventListenerType;
public static final field SELECTED Lspace/kscience/plotly/events/PlotlyEventListenerType;
public static final field SELECTING Lspace/kscience/plotly/events/PlotlyEventListenerType;
public static final field UNHOVER Lspace/kscience/plotly/events/PlotlyEventListenerType;
public final fun getEventType ()Ljava/lang/String;
public static fun valueOf (Ljava/lang/String;)Lspace/kscience/plotly/events/PlotlyEventListenerType;
public static fun values ()[Lspace/kscience/plotly/events/PlotlyEventListenerType;
}

public final class space/kscience/plotly/events/PlotlyEventPoint {
public fun <init> (ILkotlinx/serialization/json/JsonElement;Ljava/lang/Integer;Lspace/kscience/dataforge/meta/Value;Lspace/kscience/dataforge/meta/Value;)V
public synthetic fun <init> (ILkotlinx/serialization/json/JsonElement;Ljava/lang/Integer;Lspace/kscience/dataforge/meta/Value;Lspace/kscience/dataforge/meta/Value;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun component1 ()I
public final fun component2 ()Lkotlinx/serialization/json/JsonElement;
public final fun component3 ()Ljava/lang/Integer;
public final fun component4 ()Lspace/kscience/dataforge/meta/Value;
public final fun component5 ()Lspace/kscience/dataforge/meta/Value;
public final fun copy (ILkotlinx/serialization/json/JsonElement;Ljava/lang/Integer;Lspace/kscience/dataforge/meta/Value;Lspace/kscience/dataforge/meta/Value;)Lspace/kscience/plotly/events/PlotlyEventPoint;
public static synthetic fun copy$default (Lspace/kscience/plotly/events/PlotlyEventPoint;ILkotlinx/serialization/json/JsonElement;Ljava/lang/Integer;Lspace/kscience/dataforge/meta/Value;Lspace/kscience/dataforge/meta/Value;ILjava/lang/Object;)Lspace/kscience/plotly/events/PlotlyEventPoint;
public fun equals (Ljava/lang/Object;)Z
public final fun getCurveNumber ()I
public final fun getData ()Lkotlinx/serialization/json/JsonElement;
public final fun getPointNumber ()Ljava/lang/Integer;
public final fun getX ()Lspace/kscience/dataforge/meta/Value;
public final fun getY ()Lspace/kscience/dataforge/meta/Value;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class space/kscience/plotly/models/Axis : space/kscience/dataforge/meta/Scheme {
public static final field Companion Lspace/kscience/plotly/models/Axis$Companion;
public fun <init> ()V
Expand Down Expand Up @@ -1599,6 +1641,7 @@ public abstract interface class space/kscience/plotly/models/SelectedPoints {
public final class space/kscience/plotly/models/Shape : space/kscience/dataforge/meta/Scheme {
public static final field Companion Lspace/kscience/plotly/models/Shape$Companion;
public fun <init> ()V
public final fun endXY (Ljava/lang/Number;Ljava/lang/Number;)V
public final fun getEditable ()Ljava/lang/Boolean;
public final fun getFillcolor ()Lspace/kscience/plotly/models/Color;
public final fun getFillrule ()Lspace/kscience/plotly/models/ShapeFillRule;
Expand Down Expand Up @@ -1641,6 +1684,7 @@ public final class space/kscience/plotly/models/Shape : space/kscience/dataforge
public final fun setYanchor (Lspace/kscience/dataforge/meta/Value;)V
public final fun setYref (Ljava/lang/String;)V
public final fun setYsizemode (Lspace/kscience/plotly/models/ShapeSizeMode;)V
public final fun startXY (Ljava/lang/Number;Ljava/lang/Number;)V
}

public final class space/kscience/plotly/models/Shape$Companion : space/kscience/dataforge/meta/SchemeSpec {
Expand Down
6 changes: 3 additions & 3 deletions plotlykt-geo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Artifact:

The Maven coordinates of this project are `space.kscience:plotlykt-geo:0.5.3`.
The Maven coordinates of this project are `space.kscience:plotlykt-geo:0.6.0`.

**Gradle Groovy:**
```groovy
Expand All @@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:plotlykt-geo:0.5.3'
implementation 'space.kscience:plotlykt-geo:0.6.0'
}
```
**Gradle Kotlin DSL:**
Expand All @@ -27,6 +27,6 @@ repositories {
}

dependencies {
implementation("space.kscience:plotlykt-geo:0.5.3")
implementation("space.kscience:plotlykt-geo:0.6.0")
}
```
6 changes: 3 additions & 3 deletions plotlykt-jupyter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Artifact:

The Maven coordinates of this project are `space.kscience:plotlykt-jupyter:0.5.3`.
The Maven coordinates of this project are `space.kscience:plotlykt-jupyter:0.6.0`.

**Gradle Groovy:**
```groovy
Expand All @@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:plotlykt-jupyter:0.5.3'
implementation 'space.kscience:plotlykt-jupyter:0.6.0'
}
```
**Gradle Kotlin DSL:**
Expand All @@ -27,6 +27,6 @@ repositories {
}

dependencies {
implementation("space.kscience:plotlykt-jupyter:0.5.3")
implementation("space.kscience:plotlykt-jupyter:0.6.0")
}
```
6 changes: 3 additions & 3 deletions plotlykt-script/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Artifact:

The Maven coordinates of this project are `space.kscience:plotlykt-script:0.5.3`.
The Maven coordinates of this project are `space.kscience:plotlykt-script:0.6.0`.

**Gradle Groovy:**
```groovy
Expand All @@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:plotlykt-script:0.5.3'
implementation 'space.kscience:plotlykt-script:0.6.0'
}
```
**Gradle Kotlin DSL:**
Expand All @@ -27,6 +27,6 @@ repositories {
}

dependencies {
implementation("space.kscience:plotlykt-script:0.5.3")
implementation("space.kscience:plotlykt-script:0.6.0")
}
```
6 changes: 3 additions & 3 deletions plotlykt-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Artifact:

The Maven coordinates of this project are `space.kscience:plotlykt-server:0.5.3`.
The Maven coordinates of this project are `space.kscience:plotlykt-server:0.6.0`.

**Gradle Groovy:**
```groovy
Expand All @@ -16,7 +16,7 @@ repositories {
}
dependencies {
implementation 'space.kscience:plotlykt-server:0.5.3'
implementation 'space.kscience:plotlykt-server:0.6.0'
}
```
**Gradle Kotlin DSL:**
Expand All @@ -27,6 +27,6 @@ repositories {
}

dependencies {
implementation("space.kscience:plotlykt-server:0.5.3")
implementation("space.kscience:plotlykt-server:0.6.0")
}
```
6 changes: 6 additions & 0 deletions plotlykt-server/api/plotlykt-server.api
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ public final class space/kscience/plotly/server/PlotlyServerConfiguration : spac
public final fun setUpdateInterval (I)V
}

public final class space/kscience/plotly/server/PlotlyServerIntegration : org/jetbrains/kotlinx/jupyter/api/libraries/JupyterIntegration {
public fun <init> ()V
public final fun isServerStarted ()Z
public fun onLoaded (Lorg/jetbrains/kotlinx/jupyter/api/libraries/JupyterIntegration$Builder;)V
}

public final class space/kscience/plotly/server/PlotlyServerIntegrationKt {
public static final fun getJupyter (Lspace/kscience/plotly/Plotly;)Lspace/kscience/plotly/server/PlotlyServerConfiguration;
}
Expand Down

0 comments on commit 385dc05

Please sign in to comment.