larkboard

package
v3.2.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 13, 2024 License: MIT Imports: 4 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CompositeShape 

type CompositeShape struct {
	Type *string `json:"type,omitempty"` // 基础图形的具体类型
}

type CompositeShapeBuilder 

type CompositeShapeBuilder struct {
	// contains filtered or unexported fields
}

func NewCompositeShapeBuilder 

func NewCompositeShapeBuilder() *CompositeShapeBuilder

func (*CompositeShapeBuilder) Build 

func (builder *CompositeShapeBuilder) Build() *CompositeShape

func (*CompositeShapeBuilder) Type 

func (builder *CompositeShapeBuilder) Type(type_ string) *CompositeShapeBuilder

基础图形的具体类型

示例值：

type Connector 

type Connector struct {
	StartObject *ConnectorAttachedObject `json:"start_object,omitempty"` // 连线连接的起点图形
	EndObject   *ConnectorAttachedObject `json:"end_object,omitempty"`   // 连线连接的终点图形
	Captions    *ConnectorCaption        `json:"captions,omitempty"`     // 连线文本
}

type ConnectorAttachedObject 

type ConnectorAttachedObject struct {
	Id *string `json:"id,omitempty"` // 连接图形的 id
}

type ConnectorAttachedObjectBuilder 

type ConnectorAttachedObjectBuilder struct {
	// contains filtered or unexported fields
}

func NewConnectorAttachedObjectBuilder 

func NewConnectorAttachedObjectBuilder() *ConnectorAttachedObjectBuilder

func (*ConnectorAttachedObjectBuilder) Build 

func (builder *ConnectorAttachedObjectBuilder) Build() *ConnectorAttachedObject

func (*ConnectorAttachedObjectBuilder) Id 

func (builder *ConnectorAttachedObjectBuilder) Id(id string) *ConnectorAttachedObjectBuilder

连接图形的 id

示例值：o1:1

type ConnectorBuilder 

type ConnectorBuilder struct {
	// contains filtered or unexported fields
}

func NewConnectorBuilder 

func NewConnectorBuilder() *ConnectorBuilder

func (*ConnectorBuilder) Build 

func (builder *ConnectorBuilder) Build() *Connector

func (*ConnectorBuilder) Captions 

func (builder *ConnectorBuilder) Captions(captions *ConnectorCaption) *ConnectorBuilder

连线文本

示例值：

func (*ConnectorBuilder) EndObject 

func (builder *ConnectorBuilder) EndObject(endObject *ConnectorAttachedObject) *ConnectorBuilder

连线连接的终点图形

示例值：

func (*ConnectorBuilder) StartObject 

func (builder *ConnectorBuilder) StartObject(startObject *ConnectorAttachedObject) *ConnectorBuilder

连线连接的起点图形

示例值：

type ConnectorCaption 

type ConnectorCaption struct {
	Data []*Text `json:"data,omitempty"` // 文本
}

type ConnectorCaptionBuilder 

type ConnectorCaptionBuilder struct {
	// contains filtered or unexported fields
}

func NewConnectorCaptionBuilder 

func NewConnectorCaptionBuilder() *ConnectorCaptionBuilder

func (*ConnectorCaptionBuilder) Build 

func (builder *ConnectorCaptionBuilder) Build() *ConnectorCaption

func (*ConnectorCaptionBuilder) Data 

func (builder *ConnectorCaptionBuilder) Data(data []*Text) *ConnectorCaptionBuilder

文本

示例值：

type DepartmentId 

type DepartmentId struct {
	DepartmentId     *string `json:"department_id,omitempty"`      //
	OpenDepartmentId *string `json:"open_department_id,omitempty"` //
}

type DepartmentIdBuilder 

type DepartmentIdBuilder struct {
	// contains filtered or unexported fields
}

func NewDepartmentIdBuilder 

func NewDepartmentIdBuilder() *DepartmentIdBuilder

func (*DepartmentIdBuilder) Build 

func (builder *DepartmentIdBuilder) Build() *DepartmentId

func (*DepartmentIdBuilder) DepartmentId 

func (builder *DepartmentIdBuilder) DepartmentId(departmentId string) *DepartmentIdBuilder

示例值：

func (*DepartmentIdBuilder) OpenDepartmentId 

func (builder *DepartmentIdBuilder) OpenDepartmentId(openDepartmentId string) *DepartmentIdBuilder

示例值：

type Image 

type Image struct {
	Token *string `json:"token,omitempty"` // 图片 token
}

type ImageBuilder 

type ImageBuilder struct {
	// contains filtered or unexported fields
}

func NewImageBuilder 

func NewImageBuilder() *ImageBuilder

func (*ImageBuilder) Build 

func (builder *ImageBuilder) Build() *Image

func (*ImageBuilder) Token 

func (builder *ImageBuilder) Token(token string) *ImageBuilder

图片 token

示例值：EeSHb3qs9oSBXoxvw33bqtOsczb

type ListWhiteboardNodeReq 

type ListWhiteboardNodeReq struct {
	// contains filtered or unexported fields
}

type ListWhiteboardNodeReqBuilder 

type ListWhiteboardNodeReqBuilder struct {
	// contains filtered or unexported fields
}

func NewListWhiteboardNodeReqBuilder 

func NewListWhiteboardNodeReqBuilder() *ListWhiteboardNodeReqBuilder

func (*ListWhiteboardNodeReqBuilder) Build 

func (builder *ListWhiteboardNodeReqBuilder) Build() *ListWhiteboardNodeReq

func (*ListWhiteboardNodeReqBuilder) WhiteboardId 

func (builder *ListWhiteboardNodeReqBuilder) WhiteboardId(whiteboardId string) *ListWhiteboardNodeReqBuilder

画板唯一标识

示例值：Ru8nwrWFOhEmaFbEU2VbPRsHcxb

type ListWhiteboardNodeResp 

type ListWhiteboardNodeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListWhiteboardNodeRespData `json:"data"` // 业务数据
}

func (*ListWhiteboardNodeResp) Success 

func (resp *ListWhiteboardNodeResp) Success() bool

type ListWhiteboardNodeRespData 

type ListWhiteboardNodeRespData struct {
	Nodes []*WhiteboardNode `json:"nodes,omitempty"` // 查询结果
}

type MindMap 

type MindMap struct {
	ParentId *string `json:"parent_id,omitempty"` // 思维导图父节点 id ，为空表示是思维导图的根节点
}

type MindMapBuilder 

type MindMapBuilder struct {
	// contains filtered or unexported fields
}

func NewMindMapBuilder 

func NewMindMapBuilder() *MindMapBuilder

func (*MindMapBuilder) Build 

func (builder *MindMapBuilder) Build() *MindMap

func (*MindMapBuilder) ParentId 

func (builder *MindMapBuilder) ParentId(parentId string) *MindMapBuilder

思维导图父节点 id ，为空表示是思维导图的根节点

示例值：z1:1

type Section 

type Section struct {
	Title *string `json:"title,omitempty"` // 分区标题
}

type SectionBuilder 

type SectionBuilder struct {
	// contains filtered or unexported fields
}

func NewSectionBuilder 

func NewSectionBuilder() *SectionBuilder

func (*SectionBuilder) Build 

func (builder *SectionBuilder) Build() *Section

func (*SectionBuilder) Title 

func (builder *SectionBuilder) Title(title string) *SectionBuilder

分区标题

示例值：分区

type Style 

type Style struct {
	FillOpacity   *float64 `json:"fill_opacity,omitempty"`   // 填充透明度
	BorderStyle   *string  `json:"border_style,omitempty"`   // 边框样式
	BorderWidth   *string  `json:"border_width,omitempty"`   // 边框宽度
	BorderOpacity *float64 `json:"border_opacity,omitempty"` // 边框透明度
	HFlip         *bool    `json:"h_flip,omitempty"`         // 水平翻折
	VFlip         *bool    `json:"v_flip,omitempty"`         // 垂直翻折
}

type StyleBuilder 

type StyleBuilder struct {
	// contains filtered or unexported fields
}

func NewStyleBuilder 

func NewStyleBuilder() *StyleBuilder

func (*StyleBuilder) BorderOpacity 

func (builder *StyleBuilder) BorderOpacity(borderOpacity float64) *StyleBuilder

边框透明度

示例值：50

func (*StyleBuilder) BorderStyle 

func (builder *StyleBuilder) BorderStyle(borderStyle string) *StyleBuilder

边框样式

示例值：

func (*StyleBuilder) BorderWidth 

func (builder *StyleBuilder) BorderWidth(borderWidth string) *StyleBuilder

边框宽度

示例值：

func (*StyleBuilder) Build 

func (builder *StyleBuilder) Build() *Style

func (*StyleBuilder) FillOpacity 

func (builder *StyleBuilder) FillOpacity(fillOpacity float64) *StyleBuilder

填充透明度

示例值：50

func (*StyleBuilder) HFlip 

func (builder *StyleBuilder) HFlip(hFlip bool) *StyleBuilder

水平翻折

示例值：false

func (*StyleBuilder) VFlip 

func (builder *StyleBuilder) VFlip(vFlip bool) *StyleBuilder

垂直翻折

示例值：false

type Table 

type Table struct {
	Meta  *TableMeta   `json:"meta,omitempty"`  // 元信息
	Title *string      `json:"title,omitempty"` // 标题
	Cells []*TableCell `json:"cells,omitempty"` // 单元格列表
}

type TableBuilder 

type TableBuilder struct {
	// contains filtered or unexported fields
}

func NewTableBuilder 

func NewTableBuilder() *TableBuilder

func (*TableBuilder) Build 

func (builder *TableBuilder) Build() *Table

func (*TableBuilder) Cells 

func (builder *TableBuilder) Cells(cells []*TableCell) *TableBuilder

单元格列表

示例值：

func (*TableBuilder) Meta 

func (builder *TableBuilder) Meta(meta *TableMeta) *TableBuilder

元信息

示例值：

func (*TableBuilder) Title 

func (builder *TableBuilder) Title(title string) *TableBuilder

标题

示例值：表格

type TableCell 

type TableCell struct {
	RowIndex  *int                `json:"row_index,omitempty"`  // 行下标，从 1 开始
	ColIndex  *int                `json:"col_index,omitempty"`  // 列下标，从 1 开始
	MergeInfo *TableCellMergeInfo `json:"merge_info,omitempty"` // 单元格合并信息
	Children  []string            `json:"children,omitempty"`   // 单元格包含的子节点 id
	Text      *Text               `json:"text,omitempty"`       // 单元格内文字
}

type TableCellBuilder 

type TableCellBuilder struct {
	// contains filtered or unexported fields
}

func NewTableCellBuilder 

func NewTableCellBuilder() *TableCellBuilder

func (*TableCellBuilder) Build 

func (builder *TableCellBuilder) Build() *TableCell

func (*TableCellBuilder) Children 

func (builder *TableCellBuilder) Children(children []string) *TableCellBuilder

单元格包含的子节点 id

示例值：

func (*TableCellBuilder) ColIndex 

func (builder *TableCellBuilder) ColIndex(colIndex int) *TableCellBuilder

列下标，从 1 开始

示例值：1

func (*TableCellBuilder) MergeInfo 

func (builder *TableCellBuilder) MergeInfo(mergeInfo *TableCellMergeInfo) *TableCellBuilder

单元格合并信息

示例值：

func (*TableCellBuilder) RowIndex 

func (builder *TableCellBuilder) RowIndex(rowIndex int) *TableCellBuilder

行下标，从 1 开始

示例值：1

func (*TableCellBuilder) Text 

func (builder *TableCellBuilder) Text(text *Text) *TableCellBuilder

单元格内文字

示例值：

type TableCellMergeInfo 

type TableCellMergeInfo struct {
	RowSpan *int `json:"row_span,omitempty"` // 从当前行索引起被合并的连续行数
	ColSpan *int `json:"col_span,omitempty"` // 从当前列索引起被合并的连续列数
}

type TableCellMergeInfoBuilder 

type TableCellMergeInfoBuilder struct {
	// contains filtered or unexported fields
}

func NewTableCellMergeInfoBuilder 

func NewTableCellMergeInfoBuilder() *TableCellMergeInfoBuilder

func (*TableCellMergeInfoBuilder) Build 

func (builder *TableCellMergeInfoBuilder) Build() *TableCellMergeInfo

func (*TableCellMergeInfoBuilder) ColSpan 

func (builder *TableCellMergeInfoBuilder) ColSpan(colSpan int) *TableCellMergeInfoBuilder

从当前列索引起被合并的连续列数

示例值：2

func (*TableCellMergeInfoBuilder) RowSpan 

func (builder *TableCellMergeInfoBuilder) RowSpan(rowSpan int) *TableCellMergeInfoBuilder

从当前行索引起被合并的连续行数

示例值：2

type TableMeta 

type TableMeta struct {
	RowNum *int `json:"row_num,omitempty"` // 行数
	ColNum *int `json:"col_num,omitempty"` // 列数
}

type TableMetaBuilder 

type TableMetaBuilder struct {
	// contains filtered or unexported fields
}

func NewTableMetaBuilder 

func NewTableMetaBuilder() *TableMetaBuilder

func (*TableMetaBuilder) Build 

func (builder *TableMetaBuilder) Build() *TableMeta

func (*TableMetaBuilder) ColNum 

func (builder *TableMetaBuilder) ColNum(colNum int) *TableMetaBuilder

列数

示例值：3

func (*TableMetaBuilder) RowNum 

func (builder *TableMetaBuilder) RowNum(rowNum int) *TableMetaBuilder

行数

示例值：3

type Text 

type Text struct {
	Text            *string `json:"text,omitempty"`             // 文字内容
	FontWeight      *string `json:"font_weight,omitempty"`      // 文字字重
	FontSize        *int    `json:"font_size,omitempty"`        // 文字大小
	HorizontalAlign *string `json:"horizontal_align,omitempty"` // 水平对齐
	VerticalAlign   *string `json:"vertical_align,omitempty"`   // 垂直对齐
}

type TextBuilder 

type TextBuilder struct {
	// contains filtered or unexported fields
}

func NewTextBuilder 

func NewTextBuilder() *TextBuilder

func (*TextBuilder) Build 

func (builder *TextBuilder) Build() *Text

func (*TextBuilder) FontSize 

func (builder *TextBuilder) FontSize(fontSize int) *TextBuilder

文字大小

示例值：14

func (*TextBuilder) FontWeight 

func (builder *TextBuilder) FontWeight(fontWeight string) *TextBuilder

文字字重

示例值：regular

func (*TextBuilder) HorizontalAlign 

func (builder *TextBuilder) HorizontalAlign(horizontalAlign string) *TextBuilder

水平对齐

示例值：

func (*TextBuilder) Text 

func (builder *TextBuilder) Text(text string) *TextBuilder

文字内容

示例值：文字内容

func (*TextBuilder) VerticalAlign 

func (builder *TextBuilder) VerticalAlign(verticalAlign string) *TextBuilder

垂直对齐

示例值：

type V1 

type V1 struct {
	WhiteboardNode *whiteboardNode // whiteboard.node
}

func New 

func New(config *larkcore.Config) *V1

type WhiteboardNode 

type WhiteboardNode struct {
	Id             *string         `json:"id,omitempty"`              // 节点 id
	Type           *string         `json:"type,omitempty"`            // 节点图形类型，目前创建节点仅支持创建图片、文本、基础图形等类型，读取到不支持创建的图形时只返回一些基础信息，如 id、type、text、style 等
	ParentId       *string         `json:"parent_id,omitempty"`       // 父节点 id
	Children       []string        `json:"children,omitempty"`        // 子节点
	X              *float64        `json:"x,omitempty"`               // 图形相对画布的 x 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px
	Y              *float64        `json:"y,omitempty"`               // 图形相对画布的 y 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px
	Angle          *float64        `json:"angle,omitempty"`           // 图形旋转角度
	Width          *float64        `json:"width,omitempty"`           // 图形宽度，单位为 px
	Height         *float64        `json:"height,omitempty"`          // 图形高度，单位为 px
	Text           *Text           `json:"text,omitempty"`            // 图形内文字
	Style          *Style          `json:"style,omitempty"`           // 图形样式
	Image          *Image          `json:"image,omitempty"`           // 图片
	CompositeShape *CompositeShape `json:"composite_shape,omitempty"` // 基础图形属性
	Connector      *Connector      `json:"connector,omitempty"`       // 连线属性
	Section        *Section        `json:"section,omitempty"`         // 分区属性
	Table          *Table          `json:"table,omitempty"`           // 表格属性
	MindMap        *MindMap        `json:"mind_map,omitempty"`        // 思维导图属性
}

type WhiteboardNodeBuilder 

type WhiteboardNodeBuilder struct {
	// contains filtered or unexported fields
}

func NewWhiteboardNodeBuilder 

func NewWhiteboardNodeBuilder() *WhiteboardNodeBuilder

func (*WhiteboardNodeBuilder) Angle 

func (builder *WhiteboardNodeBuilder) Angle(angle float64) *WhiteboardNodeBuilder

图形旋转角度

示例值：100

func (*WhiteboardNodeBuilder) Build 

func (builder *WhiteboardNodeBuilder) Build() *WhiteboardNode

func (*WhiteboardNodeBuilder) Children 

func (builder *WhiteboardNodeBuilder) Children(children []string) *WhiteboardNodeBuilder

子节点

示例值：

func (*WhiteboardNodeBuilder) CompositeShape 

func (builder *WhiteboardNodeBuilder) CompositeShape(compositeShape *CompositeShape) *WhiteboardNodeBuilder

基础图形属性

示例值：

func (*WhiteboardNodeBuilder) Connector 

func (builder *WhiteboardNodeBuilder) Connector(connector *Connector) *WhiteboardNodeBuilder

连线属性

示例值：

func (*WhiteboardNodeBuilder) Height 

func (builder *WhiteboardNodeBuilder) Height(height float64) *WhiteboardNodeBuilder

图形高度，单位为 px

示例值：100

func (*WhiteboardNodeBuilder) Id 

func (builder *WhiteboardNodeBuilder) Id(id string) *WhiteboardNodeBuilder

节点 id

示例值：o1:1

func (*WhiteboardNodeBuilder) Image 

func (builder *WhiteboardNodeBuilder) Image(image *Image) *WhiteboardNodeBuilder

图片

示例值：

func (*WhiteboardNodeBuilder) MindMap 

func (builder *WhiteboardNodeBuilder) MindMap(mindMap *MindMap) *WhiteboardNodeBuilder

思维导图属性

示例值：

func (*WhiteboardNodeBuilder) ParentId 

func (builder *WhiteboardNodeBuilder) ParentId(parentId string) *WhiteboardNodeBuilder

父节点 id

示例值：o1:1

func (*WhiteboardNodeBuilder) Section 

func (builder *WhiteboardNodeBuilder) Section(section *Section) *WhiteboardNodeBuilder

分区属性

示例值：

func (*WhiteboardNodeBuilder) Style 

func (builder *WhiteboardNodeBuilder) Style(style *Style) *WhiteboardNodeBuilder

图形样式

示例值：

func (*WhiteboardNodeBuilder) Table 

func (builder *WhiteboardNodeBuilder) Table(table *Table) *WhiteboardNodeBuilder

表格属性

示例值：

func (*WhiteboardNodeBuilder) Text 

func (builder *WhiteboardNodeBuilder) Text(text *Text) *WhiteboardNodeBuilder

图形内文字

示例值：

func (*WhiteboardNodeBuilder) Type 

func (builder *WhiteboardNodeBuilder) Type(type_ string) *WhiteboardNodeBuilder

节点图形类型，目前创建节点仅支持创建图片、文本、基础图形等类型，读取到不支持创建的图形时只返回一些基础信息，如 id、type、text、style 等

示例值：

func (*WhiteboardNodeBuilder) Width 

func (builder *WhiteboardNodeBuilder) Width(width float64) *WhiteboardNodeBuilder

图形宽度，单位为 px

示例值：100

func (*WhiteboardNodeBuilder) X 

func (builder *WhiteboardNodeBuilder) X(x float64) *WhiteboardNodeBuilder

图形相对画布的 x 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px

示例值：100

func (*WhiteboardNodeBuilder) Y 

func (builder *WhiteboardNodeBuilder) Y(y float64) *WhiteboardNodeBuilder

图形相对画布的 y 轴位置信息（存在父容器时为相对父容器的坐标，父容器为组合图形 group 时，坐标是穿透的），单位为 px

示例值：100

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.