• Home
• net.nemerosa.ontrack
• ontrack-model
• 4.1.20
• source code
• BranchLinksDecoration.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

net.nemerosa.ontrack.model.links.BranchLinksDecoration.kt Maven / Gradle / Ivy

package net.nemerosa.ontrack.model.links

import net.nemerosa.ontrack.model.annotations.APIDescription
import net.nemerosa.ontrack.model.extension.ExtensionFeatureDescription

/**
 * Decoration for the edge between two nodes on a branch links graph.
 *
 * @property feature Feature contributing to this decoration
 * @property id ID of the decoration provider
 * @property text Short text to display at edge level for the decoration
 * @property description Optional longer text, typically used as a tooltip
 * @property icon Optional name to an image for the decoration. This name is used together with the [feature] and the [id] to build a URL on the client side
 * @property url Optional link from the decoration to another page
 */
@APIDescription("Decoration for the edge between two nodes on a branch links graph.")
class BranchLinksDecoration(
    @APIDescription("Feature contributing to this decoration")
    val feature: ExtensionFeatureDescription,
    @APIDescription("ID of the decoration provider")
    val id: String,
    @APIDescription("Short text to display at edge level for the decoration")
    val text: String,
    @APIDescription("Optional longer text, typically used as a tooltip")
    val description: String? = null,
    @APIDescription("Optional name to an image for the decoration. This name is used together with the [feature] and the [id] to build a URL on the client side")
    val icon: String? = null,
    @APIDescription("Optional link from the decoration to another page")
    val url: String? = null
)