Documentation
¶
Index ¶
- Variables
- func Compare(left *Fraction, cmp *Comparator) bool
- type Comparator
- func (*Comparator) Descriptor() ([]byte, []int)deprecated
- func (x *Comparator) GetSign() Comparator_Sign
- func (x *Comparator) GetValue() *Fraction
- func (*Comparator) ProtoMessage()
- func (x *Comparator) ProtoReflect() protoreflect.Message
- func (x *Comparator) Reset()
- func (x *Comparator) String() string
- type Comparator_Sign
- func (Comparator_Sign) Descriptor() protoreflect.EnumDescriptor
- func (x Comparator_Sign) Enum() *Comparator_Sign
- func (Comparator_Sign) EnumDescriptor() ([]byte, []int)deprecated
- func (x Comparator_Sign) Number() protoreflect.EnumNumber
- func (x Comparator_Sign) String() string
- func (Comparator_Sign) Type() protoreflect.EnumType
- type EnumOptions
- type EnumValueOptions
- func (*EnumValueOptions) Descriptor() ([]byte, []int)deprecated
- func (x *EnumValueOptions) GetName() string
- func (x *EnumValueOptions) GetNote() string
- func (*EnumValueOptions) ProtoMessage()
- func (x *EnumValueOptions) ProtoReflect() protoreflect.Message
- func (x *EnumValueOptions) Reset()
- func (x *EnumValueOptions) String() string
- type FieldOptions
- func (*FieldOptions) Descriptor() ([]byte, []int)deprecated
- func (x *FieldOptions) GetKey() string
- func (x *FieldOptions) GetLayout() Layout
- func (x *FieldOptions) GetName() string
- func (x *FieldOptions) GetNote() string
- func (x *FieldOptions) GetProp() *FieldProp
- func (x *FieldOptions) GetSpan() Span
- func (*FieldOptions) ProtoMessage()
- func (x *FieldOptions) ProtoReflect() protoreflect.Message
- func (x *FieldOptions) Reset()
- func (x *FieldOptions) String() string
- type FieldProp
- func (*FieldProp) Descriptor() ([]byte, []int)deprecated
- func (x *FieldProp) GetAggregate() bool
- func (x *FieldProp) GetDefault() string
- func (x *FieldProp) GetFixed() bool
- func (x *FieldProp) GetForm() Form
- func (x *FieldProp) GetJsonName() string
- func (x *FieldProp) GetOptional() bool
- func (x *FieldProp) GetOrder() Order
- func (x *FieldProp) GetPatch() Patch
- func (x *FieldProp) GetPattern() string
- func (x *FieldProp) GetPresent() bool
- func (x *FieldProp) GetRange() string
- func (x *FieldProp) GetRefer() string
- func (x *FieldProp) GetSep() string
- func (x *FieldProp) GetSequence() int64
- func (x *FieldProp) GetSize() uint32
- func (x *FieldProp) GetSubsep() string
- func (x *FieldProp) GetUnique() bool
- func (x *FieldProp) GetValidate() string
- func (x *FieldProp) GetValidateComplex() string
- func (x *FieldProp) GetValidateMessage() string
- func (*FieldProp) ProtoMessage()
- func (x *FieldProp) ProtoReflect() protoreflect.Message
- func (x *FieldProp) Reset()
- func (x *FieldProp) String() string
- type Form
- type Fraction
- func (f *Fraction) Cmp(cmp *Comparator) bool
- func (*Fraction) Descriptor() ([]byte, []int)deprecated
- func (x *Fraction) GetDen() int32
- func (x *Fraction) GetNum() int32
- func (*Fraction) ProtoMessage()
- func (x *Fraction) ProtoReflect() protoreflect.Message
- func (x *Fraction) Reset()
- func (x *Fraction) String() string
- type Layout
- type Mode
- type OneofOptions
- func (*OneofOptions) Descriptor() ([]byte, []int)deprecated
- func (x *OneofOptions) GetField() string
- func (x *OneofOptions) GetName() string
- func (x *OneofOptions) GetNote() string
- func (*OneofOptions) ProtoMessage()
- func (x *OneofOptions) ProtoReflect() protoreflect.Message
- func (x *OneofOptions) Reset()
- func (x *OneofOptions) String() string
- type Order
- type Patch
- type Span
- type StructOptions
- func (*StructOptions) Descriptor() ([]byte, []int)deprecated
- func (x *StructOptions) GetName() string
- func (x *StructOptions) GetNote() string
- func (*StructOptions) ProtoMessage()
- func (x *StructOptions) ProtoReflect() protoreflect.Message
- func (x *StructOptions) Reset()
- func (x *StructOptions) String() string
- type UnionOptions
- func (*UnionOptions) Descriptor() ([]byte, []int)deprecated
- func (x *UnionOptions) GetName() string
- func (x *UnionOptions) GetNote() string
- func (*UnionOptions) ProtoMessage()
- func (x *UnionOptions) ProtoReflect() protoreflect.Message
- func (x *UnionOptions) Reset()
- func (x *UnionOptions) String() string
- type Vector2
- type Vector2I
- type Vector3
- type Vector3I
- func (*Vector3I) Descriptor() ([]byte, []int)deprecated
- func (x *Vector3I) GetX() int32
- func (x *Vector3I) GetY() int32
- func (x *Vector3I) GetZ() int32
- func (*Vector3I) ProtoMessage()
- func (x *Vector3I) ProtoReflect() protoreflect.Message
- func (x *Vector3I) Reset()
- func (x *Vector3I) String() string
- type Vector4
- func (*Vector4) Descriptor() ([]byte, []int)deprecated
- func (x *Vector4) GetW() float32
- func (x *Vector4) GetX() float32
- func (x *Vector4) GetY() float32
- func (x *Vector4) GetZ() float32
- func (*Vector4) ProtoMessage()
- func (x *Vector4) ProtoReflect() protoreflect.Message
- func (x *Vector4) Reset()
- func (x *Vector4) String() string
- type Vector4I
- func (*Vector4I) Descriptor() ([]byte, []int)deprecated
- func (x *Vector4I) GetW() int32
- func (x *Vector4I) GetX() int32
- func (x *Vector4I) GetY() int32
- func (x *Vector4I) GetZ() int32
- func (*Vector4I) ProtoMessage()
- func (x *Vector4I) ProtoReflect() protoreflect.Message
- func (x *Vector4I) Reset()
- func (x *Vector4I) String() string
- type Version
- func (*Version) Descriptor() ([]byte, []int)deprecated
- func (x *Version) GetMajor() uint32
- func (x *Version) GetMinor() uint32
- func (x *Version) GetOthers() []uint32
- func (x *Version) GetPatch() uint32
- func (x *Version) GetStr() string
- func (x *Version) GetVal() uint64
- func (*Version) ProtoMessage()
- func (x *Version) ProtoReflect() protoreflect.Message
- func (x *Version) Reset()
- func (x *Version) String() string
- type WorkbookOptions
- func (*WorkbookOptions) Descriptor() ([]byte, []int)deprecated
- func (x *WorkbookOptions) GetAlias() string
- func (x *WorkbookOptions) GetDatarow() int32
- func (x *WorkbookOptions) GetName() string
- func (x *WorkbookOptions) GetNameline() int32
- func (x *WorkbookOptions) GetNamerow() int32
- func (x *WorkbookOptions) GetNoteline() int32
- func (x *WorkbookOptions) GetNoterow() int32
- func (x *WorkbookOptions) GetSep() string
- func (x *WorkbookOptions) GetSubsep() string
- func (x *WorkbookOptions) GetTypeline() int32
- func (x *WorkbookOptions) GetTyperow() int32
- func (*WorkbookOptions) ProtoMessage()
- func (x *WorkbookOptions) ProtoReflect() protoreflect.Message
- func (x *WorkbookOptions) Reset()
- func (x *WorkbookOptions) String() string
- type WorksheetOptions
- func (*WorksheetOptions) Descriptor() ([]byte, []int)deprecated
- func (x *WorksheetOptions) GetAdjacentKey() bool
- func (x *WorksheetOptions) GetDatarow() int32
- func (x *WorksheetOptions) GetFieldPresence() bool
- func (x *WorksheetOptions) GetIndex() []string
- func (x *WorksheetOptions) GetLabels() map[string]string
- func (x *WorksheetOptions) GetLangOptions() map[string]string
- func (x *WorksheetOptions) GetMerger() []string
- func (x *WorksheetOptions) GetMode() Mode
- func (x *WorksheetOptions) GetName() string
- func (x *WorksheetOptions) GetNameline() int32
- func (x *WorksheetOptions) GetNamerow() int32
- func (x *WorksheetOptions) GetNested() bool
- func (x *WorksheetOptions) GetNoteline() int32
- func (x *WorksheetOptions) GetNoterow() int32
- func (x *WorksheetOptions) GetOptional() bool
- func (x *WorksheetOptions) GetOrderedIndex() []string
- func (x *WorksheetOptions) GetOrderedMap() bool
- func (x *WorksheetOptions) GetPatch() Patch
- func (x *WorksheetOptions) GetScatter() []string
- func (x *WorksheetOptions) GetScatterWithoutBookName() bool
- func (x *WorksheetOptions) GetSep() string
- func (x *WorksheetOptions) GetSubsep() string
- func (x *WorksheetOptions) GetTemplate() bool
- func (x *WorksheetOptions) GetTranspose() bool
- func (x *WorksheetOptions) GetTypeline() int32
- func (x *WorksheetOptions) GetTyperow() int32
- func (x *WorksheetOptions) GetValidate() string
- func (x *WorksheetOptions) GetWithParentDir() bool
- func (*WorksheetOptions) ProtoMessage()
- func (x *WorksheetOptions) ProtoReflect() protoreflect.Message
- func (x *WorksheetOptions) Reset()
- func (x *WorksheetOptions) String() string
Constants ¶
This section is empty.
Variables ¶
var ( Layout_name = map[int32]string{ 0: "LAYOUT_DEFAULT", 1: "LAYOUT_VERTICAL", 2: "LAYOUT_HORIZONTAL", 3: "LAYOUT_INCELL", } Layout_value = map[string]int32{ "LAYOUT_DEFAULT": 0, "LAYOUT_VERTICAL": 1, "LAYOUT_HORIZONTAL": 2, "LAYOUT_INCELL": 3, } )
Enum value maps for Layout.
var ( Span_name = map[int32]string{ 0: "SPAN_DEFAULT", 1: "SPAN_CROSS_CELL", 2: "SPAN_INNER_CELL", } Span_value = map[string]int32{ "SPAN_DEFAULT": 0, "SPAN_CROSS_CELL": 1, "SPAN_INNER_CELL": 2, } )
Enum value maps for Span.
var ( Mode_name = map[int32]string{ 0: "MODE_DEFAULT", 1: "MODE_ENUM_TYPE", 2: "MODE_ENUM_TYPE_MULTI", 3: "MODE_STRUCT_TYPE", 4: "MODE_STRUCT_TYPE_MULTI", 5: "MODE_UNION_TYPE", 6: "MODE_UNION_TYPE_MULTI", 10: "MODE_UE_CSV", 11: "MODE_UE_JSON", } Mode_value = map[string]int32{ "MODE_DEFAULT": 0, "MODE_ENUM_TYPE": 1, "MODE_ENUM_TYPE_MULTI": 2, "MODE_STRUCT_TYPE": 3, "MODE_STRUCT_TYPE_MULTI": 4, "MODE_UNION_TYPE": 5, "MODE_UNION_TYPE_MULTI": 6, "MODE_UE_CSV": 10, "MODE_UE_JSON": 11, } )
Enum value maps for Mode.
var ( Form_name = map[int32]string{ 0: "FORM_DEFAULT", 1: "FORM_TEXT", 2: "FORM_JSON", } Form_value = map[string]int32{ "FORM_DEFAULT": 0, "FORM_TEXT": 1, "FORM_JSON": 2, } )
Enum value maps for Form.
var ( Patch_name = map[int32]string{ 0: "PATCH_NONE", 1: "PATCH_REPLACE", 2: "PATCH_MERGE", } Patch_value = map[string]int32{ "PATCH_NONE": 0, "PATCH_REPLACE": 1, "PATCH_MERGE": 2, } )
Enum value maps for Patch.
var ( Order_name = map[int32]string{ 0: "ORDER_NONE", 1: "ORDER_ASC", 2: "ORDER_DESC", 3: "ORDER_STRICTLY_ASC", 4: "ORDER_STRICTLY_DESC", } Order_value = map[string]int32{ "ORDER_NONE": 0, "ORDER_ASC": 1, "ORDER_DESC": 2, "ORDER_STRICTLY_ASC": 3, "ORDER_STRICTLY_DESC": 4, } )
Enum value maps for Order.
var ( // optional tableau.WorksheetOptions worksheet = 50000; E_Worksheet = &file_tableau_protobuf_tableau_proto_extTypes[1] // optional tableau.StructOptions struct = 50001; E_Struct = &file_tableau_protobuf_tableau_proto_extTypes[2] // optional tableau.UnionOptions union = 50002; E_Union = &file_tableau_protobuf_tableau_proto_extTypes[3] )
Extension fields to descriptorpb.MessageOptions.
var ( Comparator_Sign_name = map[int32]string{ 0: "SIGN_EQUAL", 1: "SIGN_NOT_EQUAL", 2: "SIGN_LESS", 3: "SIGN_LESS_OR_EQUAL", 4: "SIGN_GREATER", 5: "SIGN_GREATER_OR_EQUAL", } Comparator_Sign_value = map[string]int32{ "SIGN_EQUAL": 0, "SIGN_NOT_EQUAL": 1, "SIGN_LESS": 2, "SIGN_LESS_OR_EQUAL": 3, "SIGN_GREATER": 4, "SIGN_GREATER_OR_EQUAL": 5, } )
Enum value maps for Comparator_Sign.
var (
// optional tableau.EnumOptions etype = 50000;
E_Etype = &file_tableau_protobuf_tableau_proto_extTypes[5]
)
Extension fields to descriptorpb.EnumOptions.
var (
// optional tableau.EnumValueOptions evalue = 50000;
E_Evalue = &file_tableau_protobuf_tableau_proto_extTypes[6]
)
Extension fields to descriptorpb.EnumValueOptions.
var (
// optional tableau.FieldOptions field = 50000;
E_Field = &file_tableau_protobuf_tableau_proto_extTypes[4]
)
Extension fields to descriptorpb.FieldOptions.
var (
// optional tableau.OneofOptions oneof = 50000;
E_Oneof = &file_tableau_protobuf_tableau_proto_extTypes[7]
)
Extension fields to descriptorpb.OneofOptions.
var (
// optional tableau.WorkbookOptions workbook = 50000;
E_Workbook = &file_tableau_protobuf_tableau_proto_extTypes[0]
)
Extension fields to descriptorpb.FileOptions.
var File_tableau_protobuf_tableau_proto protoreflect.FileDescriptor
var File_tableau_protobuf_wellknown_proto protoreflect.FileDescriptor
Functions ¶
func Compare ¶ added in v0.14.0
func Compare(left *Fraction, cmp *Comparator) bool
Compare returns true if the given fraction matches the given comparator.
Types ¶
type Comparator ¶ added in v0.12.0
type Comparator struct {
Sign Comparator_Sign `protobuf:"varint,1,opt,name=sign,proto3,enum=tableau.Comparator_Sign" json:"sign,omitempty"`
Value *Fraction `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
Format: <Sign><Fraction> e.g.: ==10, !=1/2, <10%, <=10‰, >10%, >=10‱
func NewComparator ¶ added in v0.14.0
func NewComparator(sign Comparator_Sign, num, den int32) *Comparator
NewComparator creates a new fraction comparator.
func NewIntegerComparator ¶ added in v0.14.0
func NewIntegerComparator(sign Comparator_Sign, num int32) *Comparator
NewIntegerComparator creates a new comparator compared to a special fraction: integer. When a fraction has a denominator of 1 (e.g.: a/1), it is referred to as a whole number or an integer.
func (*Comparator) Descriptor
deprecated
added in
v0.12.0
func (*Comparator) Descriptor() ([]byte, []int)
Deprecated: Use Comparator.ProtoReflect.Descriptor instead.
func (*Comparator) GetSign ¶ added in v0.12.0
func (x *Comparator) GetSign() Comparator_Sign
func (*Comparator) GetValue ¶ added in v0.12.0
func (x *Comparator) GetValue() *Fraction
func (*Comparator) ProtoMessage ¶ added in v0.12.0
func (*Comparator) ProtoMessage()
func (*Comparator) ProtoReflect ¶ added in v0.12.0
func (x *Comparator) ProtoReflect() protoreflect.Message
func (*Comparator) Reset ¶ added in v0.12.0
func (x *Comparator) Reset()
func (*Comparator) String ¶ added in v0.12.0
func (x *Comparator) String() string
type Comparator_Sign ¶ added in v0.12.0
type Comparator_Sign int32
const ( Comparator_SIGN_EQUAL Comparator_Sign = 0 // == Comparator_SIGN_NOT_EQUAL Comparator_Sign = 1 // != Comparator_SIGN_LESS Comparator_Sign = 2 // < Comparator_SIGN_LESS_OR_EQUAL Comparator_Sign = 3 // <= Comparator_SIGN_GREATER Comparator_Sign = 4 // > Comparator_SIGN_GREATER_OR_EQUAL Comparator_Sign = 5 // >= )
func (Comparator_Sign) Descriptor ¶ added in v0.12.0
func (Comparator_Sign) Descriptor() protoreflect.EnumDescriptor
func (Comparator_Sign) Enum ¶ added in v0.12.0
func (x Comparator_Sign) Enum() *Comparator_Sign
func (Comparator_Sign) EnumDescriptor
deprecated
added in
v0.12.0
func (Comparator_Sign) EnumDescriptor() ([]byte, []int)
Deprecated: Use Comparator_Sign.Descriptor instead.
func (Comparator_Sign) Number ¶ added in v0.12.0
func (x Comparator_Sign) Number() protoreflect.EnumNumber
func (Comparator_Sign) String ¶ added in v0.12.0
func (x Comparator_Sign) String() string
func (Comparator_Sign) Type ¶ added in v0.12.0
func (Comparator_Sign) Type() protoreflect.EnumType
type EnumOptions ¶
type EnumOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Worksheet name.
Note string `protobuf:"bytes,2,opt,name=note,proto3" json:"note,omitempty"` // Enum type note. Maybe in another language (Chinese).
// contains filtered or unexported fields
}
func (*EnumOptions) Descriptor
deprecated
func (*EnumOptions) Descriptor() ([]byte, []int)
Deprecated: Use EnumOptions.ProtoReflect.Descriptor instead.
func (*EnumOptions) GetName ¶
func (x *EnumOptions) GetName() string
func (*EnumOptions) GetNote ¶ added in v0.12.0
func (x *EnumOptions) GetNote() string
func (*EnumOptions) ProtoMessage ¶
func (*EnumOptions) ProtoMessage()
func (*EnumOptions) ProtoReflect ¶
func (x *EnumOptions) ProtoReflect() protoreflect.Message
func (*EnumOptions) Reset ¶
func (x *EnumOptions) Reset()
func (*EnumOptions) String ¶
func (x *EnumOptions) String() string
type EnumValueOptions ¶
type EnumValueOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Enum value alias.
Note string `protobuf:"bytes,2,opt,name=note,proto3" json:"note,omitempty"` // Enum value note. Maybe in another language (Chinese).
// contains filtered or unexported fields
}
func (*EnumValueOptions) Descriptor
deprecated
func (*EnumValueOptions) Descriptor() ([]byte, []int)
Deprecated: Use EnumValueOptions.ProtoReflect.Descriptor instead.
func (*EnumValueOptions) GetName ¶
func (x *EnumValueOptions) GetName() string
func (*EnumValueOptions) GetNote ¶ added in v0.12.0
func (x *EnumValueOptions) GetNote() string
func (*EnumValueOptions) ProtoMessage ¶
func (*EnumValueOptions) ProtoMessage()
func (*EnumValueOptions) ProtoReflect ¶
func (x *EnumValueOptions) ProtoReflect() protoreflect.Message
func (*EnumValueOptions) Reset ¶
func (x *EnumValueOptions) Reset()
func (*EnumValueOptions) String ¶
func (x *EnumValueOptions) String() string
type FieldOptions ¶
type FieldOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Scalar type's variable name or composite type's variable name (prefix).
Note string `protobuf:"bytes,2,opt,name=note,proto3" json:"note,omitempty"` // Field note. Maybe in another language (Chinese).
Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"` // Only set when this field type is map or keyed-list.
Layout Layout `protobuf:"varint,4,opt,name=layout,proto3,enum=tableau.Layout" json:"layout,omitempty"` // For map/list types with cardinality. Default: LAYOUT_DEFAULT.
Span Span `protobuf:"varint,5,opt,name=span,proto3,enum=tableau.Span" json:"span,omitempty"` // For list element or map value types. Default: SPAN_CROSS_CELL.
Prop *FieldProp `protobuf:"bytes,15,opt,name=prop,proto3" json:"prop,omitempty"` // Property of field.
// contains filtered or unexported fields
}
func (*FieldOptions) Descriptor
deprecated
func (*FieldOptions) Descriptor() ([]byte, []int)
Deprecated: Use FieldOptions.ProtoReflect.Descriptor instead.
func (*FieldOptions) GetKey ¶
func (x *FieldOptions) GetKey() string
func (*FieldOptions) GetLayout ¶
func (x *FieldOptions) GetLayout() Layout
func (*FieldOptions) GetName ¶
func (x *FieldOptions) GetName() string
func (*FieldOptions) GetNote ¶
func (x *FieldOptions) GetNote() string
func (*FieldOptions) GetProp ¶ added in v0.9.1
func (x *FieldOptions) GetProp() *FieldProp
func (*FieldOptions) GetSpan ¶ added in v0.9.15
func (x *FieldOptions) GetSpan() Span
func (*FieldOptions) ProtoMessage ¶
func (*FieldOptions) ProtoMessage()
func (*FieldOptions) ProtoReflect ¶
func (x *FieldOptions) ProtoReflect() protoreflect.Message
func (*FieldOptions) Reset ¶
func (x *FieldOptions) Reset()
func (*FieldOptions) String ¶
func (x *FieldOptions) String() string
type FieldProp ¶ added in v0.9.1
type FieldProp struct {
// Different interpretations of range:
// - number: value range
// - string: count of utf-8 code point
//
// Format: "1,10", "1,~", "~,10".
Range string `protobuf:"bytes,1,opt,name=range,proto3" json:"range,omitempty"`
// Whether the map key is unique in column.
// If not set, then auto deduce whether the map key is unique or not.
Unique *bool `protobuf:"varint,2,opt,name=unique,proto3,oneof" json:"unique,omitempty"`
// Ensure this field's value is in another sheet's
// column value space (aka message's field value space).
//
// Format: "SheetName.ColumnName" or "SheetName(SheetAlias).ColumnName"
//
// Example:
// - "SheetName.ColumnName": e.g. "Item.ID", without sheet alias, and
// the sheet name is the generated protobuf message name.
// - "SheetName(SheetAlias).ColumnName": e.g. "Item(ItemConf).ID", with
// sheet alias, and sheet alias is the generated protobuf message name.
Refer string `protobuf:"bytes,3,opt,name=refer,proto3" json:"refer,omitempty"`
// Ensure this field's value is a sequence and begins with this value.
// Mainly used for map key and list element.
Sequence *int64 `protobuf:"varint,4,opt,name=sequence,proto3,oneof" json:"sequence,omitempty"`
// Specify custom default value of scalar field.
Default string `protobuf:"bytes,5,opt,name=default,proto3" json:"default,omitempty"`
// Auto detect fixed size of horizontal list or map.
// - list size is detected by size of the max present list elements in name row.
// - map size is detected by size of the max present map items in name row.
Fixed bool `protobuf:"varint,6,opt,name=fixed,proto3" json:"fixed,omitempty"`
// Specify fixed size of horizontal list or map.
Size uint32 `protobuf:"varint,7,opt,name=size,proto3" json:"size,omitempty"`
// Specify cell data form for parsing.
Form Form `protobuf:"varint,8,opt,name=form,proto3,enum=tableau.Form" json:"form,omitempty"`
// JSON name of this field. The value is set by protocol compiler. If the
// user has set a "json_name" option on this field, that option's value
// will be used. Otherwise, it's deduced from the field's name by converting
// it to camelCase.
JsonName string `protobuf:"bytes,9,opt,name=json_name,json=jsonName,proto3" json:"json_name,omitempty"`
// Whether this field value is present (field value existence).
// If set to true, then do the following checks for different field types:
// - scalar/enum: cell data cannot be empty string (TODO: If this field's
// type is string, then how to set empty string explicitly?)
// - struct: check at least one field is present recursively
// - map/list: len(elements) > 0
Present bool `protobuf:"varint,10,opt,name=present,proto3" json:"present,omitempty"`
// Whether this field is optional (field name existence).
// If set to true, then:
// - table formats (Excel/CSV): field's column can be absent.
// - document formats (XML/YAML): field's name can be absent.
Optional bool `protobuf:"varint,11,opt,name=optional,proto3" json:"optional,omitempty"`
// Field patch type.
Patch Patch `protobuf:"varint,12,opt,name=patch,proto3,enum=tableau.Patch" json:"patch,omitempty"`
// Field-level separator for separating:
// - incell list elements (scalar or struct).
// - incell map items.
//
// If set, it will overwrite sheet-level seq in WorksheetOptions.
Sep string `protobuf:"bytes,13,opt,name=sep,proto3" json:"sep,omitempty"`
// Field-level subseparator for separating:
// - key-value pair of each incell map item.
// - struct fields of each incell struct list element.
//
// If set, it will overwrite sheet-level subseq in WorksheetOptions.
Subsep string `protobuf:"bytes,14,opt,name=subsep,proto3" json:"subsep,omitempty"`
// Specify the pattern of scalar, list element, and map value.
//
// For version (tableau.Version) field:
//
// Specify the dotted-decimal pattern of current cell. Each decimal
// number ranges from 0 to the corresponding part (MAX) of pattern.
// Default pattern: "255.255.255".
//
// TODO: use cases for more field types.
Pattern string `protobuf:"bytes,16,opt,name=pattern,proto3" json:"pattern,omitempty"`
// Ensure this field's value is in order.
Order Order `protobuf:"varint,17,opt,name=order,proto3,enum=tableau.Order" json:"order,omitempty"`
// Protovalidate field-level rules of scalar and well-known types. The value is
// a text-format representation of buf.validate.FieldRules, e.g.: "string:{max_len:10}".
//
// See https://github.com/bufbuild/protovalidate.
Validate string `protobuf:"bytes,18,opt,name=validate,proto3" json:"validate,omitempty"`
// Protovalidate field-level rules of complex types: list, map. The value is a text-format
// representation of buf.validate.FieldRules, e.g.: "repeated:{min_items:1}".
//
// See https://github.com/bufbuild/protovalidate.
ValidateComplex string `protobuf:"bytes,19,opt,name=validate_complex,json=validateComplex,proto3" json:"validate_complex,omitempty"`
// Protovalidate message-level rules for the nested message corresponding to
// this field. The value is a text-format representation of buf.validate.MessageRules,
// e.g.: cel_expression:"this.begin > this.end ? 'begin(%s) must <= end(%s)'.format([this.begin, this.end]): ”".
//
// See https://github.com/bufbuild/protovalidate.
ValidateMessage string `protobuf:"bytes,20,opt,name=validate_message,json=validateMessage,proto3" json:"validate_message,omitempty"`
// If true, this incell map/list field aggregates elements from repeated
// visits to the same enclosing message into a single combined collection.
// Repeated visits occur when multiple rows or columns parse into the same
// message, e.g.:
// - vertical map/keyed-list with same key across rows
// - horizontal map with same key across columns
// - vertical/horizontal list spanning multiple rows/columns (sibling
// incell fields revisited per row or column)
//
// Without aggregate (default): all visits must produce the identical incell
// value, otherwise error E2023 is reported.
//
// With aggregate:
// - incell map: merges entries from each visit; duplicate map keys across
// visits report error E2005.
// - incell list: appends elements from each visit unconditionally.
// - incell keyed-list: appends elements from each visit; duplicate keys
// across visits report error E2028.
Aggregate bool `protobuf:"varint,21,opt,name=aggregate,proto3" json:"aggregate,omitempty"`
// contains filtered or unexported fields
}
func (*FieldProp) Descriptor
deprecated
added in
v0.9.1
func (*FieldProp) GetAggregate ¶ added in v0.16.0
func (*FieldProp) GetDefault ¶ added in v0.9.2
func (*FieldProp) GetJsonName ¶ added in v0.10.7
func (*FieldProp) GetOptional ¶ added in v0.11.0
func (*FieldProp) GetPattern ¶ added in v0.14.0
func (*FieldProp) GetPresent ¶ added in v0.11.0
func (*FieldProp) GetSequence ¶ added in v0.9.17
func (*FieldProp) GetValidate ¶ added in v0.16.0
func (*FieldProp) GetValidateComplex ¶ added in v0.16.0
func (*FieldProp) GetValidateMessage ¶ added in v0.16.0
func (*FieldProp) ProtoMessage ¶ added in v0.9.1
func (*FieldProp) ProtoMessage()
func (*FieldProp) ProtoReflect ¶ added in v0.9.1
func (x *FieldProp) ProtoReflect() protoreflect.Message
type Form ¶ added in v0.10.7
type Form int32
Cell data form.
const ( Form_FORM_DEFAULT Form = 0 // Default form which confgen parser will parse. Form_FORM_TEXT Form = 1 // Refer: https://developers.google.com/protocol-buffers/docs/text-format-spec Form_FORM_JSON Form = 2 // Refer: https://developers.google.com/protocol-buffers/docs/proto3#json )
func (Form) Descriptor ¶ added in v0.10.7
func (Form) Descriptor() protoreflect.EnumDescriptor
func (Form) EnumDescriptor
deprecated
added in
v0.10.7
func (Form) Number ¶ added in v0.10.7
func (x Form) Number() protoreflect.EnumNumber
func (Form) Type ¶ added in v0.10.7
func (Form) Type() protoreflect.EnumType
type Fraction ¶ added in v0.12.0
type Fraction struct {
Num int32 `protobuf:"varint,1,opt,name=num,proto3" json:"num,omitempty"` // numerator
Den int32 `protobuf:"varint,2,opt,name=den,proto3" json:"den,omitempty"` // denominator
// contains filtered or unexported fields
}
Supported formats:
- N%: percentage, e.g.: 10%
- N‰: per thounsand, e.g.: 10‰
- N‱: per ten thounsand, e.g.: 10‱
- N/D: simple fraction, e.g.: 3/4
- N: only numerator, e.g.: 3 is same to 3/1
func NewFraction ¶ added in v0.14.0
NewFraction creates a new fraction.
func NewIntegerFraction ¶ added in v0.14.0
NewIntegerFraction creates a new special fraction: integer. When a fraction has a denominator of 1 (e.g.: a/1), it is referred to as a whole number or an integer.
func (*Fraction) Cmp ¶ added in v0.16.0
func (f *Fraction) Cmp(cmp *Comparator) bool
func (*Fraction) Descriptor
deprecated
added in
v0.12.0
func (*Fraction) ProtoMessage ¶ added in v0.12.0
func (*Fraction) ProtoMessage()
func (*Fraction) ProtoReflect ¶ added in v0.12.0
func (x *Fraction) ProtoReflect() protoreflect.Message
type Layout ¶
type Layout int32
Layout of list and map.
const ( // Default: // - vertical for struct map // - incell for scalar map // - horizontal for struct list // - incell for scalar list Layout_LAYOUT_DEFAULT Layout = 0 Layout_LAYOUT_VERTICAL Layout = 1 // Vertical Layout_LAYOUT_HORIZONTAL Layout = 2 // Horizontal Layout_LAYOUT_INCELL Layout = 3 // Incell )
func (Layout) Descriptor ¶
func (Layout) Descriptor() protoreflect.EnumDescriptor
func (Layout) EnumDescriptor
deprecated
func (Layout) Number ¶
func (x Layout) Number() protoreflect.EnumNumber
func (Layout) Type ¶
func (Layout) Type() protoreflect.EnumType
type Mode ¶ added in v0.10.7
type Mode int32
Sheet mode.
const ( Mode_MODE_DEFAULT Mode = 0 // Default mode. Mode_MODE_ENUM_TYPE Mode = 1 // Enum type: single definition in a sheet. Mode_MODE_ENUM_TYPE_MULTI Mode = 2 // Enum type: multiple definitions in a sheet. Mode_MODE_STRUCT_TYPE Mode = 3 // Struct type: single definition in a sheet. Mode_MODE_STRUCT_TYPE_MULTI Mode = 4 // Struct type: multiple definitions in a sheet. Mode_MODE_UNION_TYPE Mode = 5 // Union type: single definition in a sheet. Mode_MODE_UNION_TYPE_MULTI Mode = 6 // Union type: multiple definitions in a sheet. // UE DataTable references: // - https://dev.epicgames.com/documentation/en-us/unreal-engine/data-driven-gameplay-elements-in-unreal-engine // - https://dev.epicgames.com/documentation/en-us/unreal-engine/BlueprintAPI/EditorScripting/DataTable Mode_MODE_UE_CSV Mode = 10 // TODO: CSV format of UE DataTable. Mode_MODE_UE_JSON Mode = 11 // TODO: JSON format of UE DataTable. )
func (Mode) Descriptor ¶ added in v0.10.7
func (Mode) Descriptor() protoreflect.EnumDescriptor
func (Mode) EnumDescriptor
deprecated
added in
v0.10.7
func (Mode) Number ¶ added in v0.10.7
func (x Mode) Number() protoreflect.EnumNumber
func (Mode) Type ¶ added in v0.10.7
func (Mode) Type() protoreflect.EnumType
type OneofOptions ¶ added in v0.10.7
type OneofOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Oneof alias. NOT USED yet.
Note string `protobuf:"bytes,2,opt,name=note,proto3" json:"note,omitempty"` // Oneof note, maybe in another language (Chinese).
Field string `protobuf:"bytes,3,opt,name=field,proto3" json:"field,omitempty"` // Field name.
// contains filtered or unexported fields
}
func (*OneofOptions) Descriptor
deprecated
added in
v0.10.7
func (*OneofOptions) Descriptor() ([]byte, []int)
Deprecated: Use OneofOptions.ProtoReflect.Descriptor instead.
func (*OneofOptions) GetField ¶ added in v0.10.7
func (x *OneofOptions) GetField() string
func (*OneofOptions) GetName ¶ added in v0.10.7
func (x *OneofOptions) GetName() string
func (*OneofOptions) GetNote ¶ added in v0.12.0
func (x *OneofOptions) GetNote() string
func (*OneofOptions) ProtoMessage ¶ added in v0.10.7
func (*OneofOptions) ProtoMessage()
func (*OneofOptions) ProtoReflect ¶ added in v0.10.7
func (x *OneofOptions) ProtoReflect() protoreflect.Message
func (*OneofOptions) Reset ¶ added in v0.10.7
func (x *OneofOptions) Reset()
func (*OneofOptions) String ¶ added in v0.10.7
func (x *OneofOptions) String() string
type Order ¶ added in v0.15.0
type Order int32
Field value order.
func (Order) Descriptor ¶ added in v0.15.0
func (Order) Descriptor() protoreflect.EnumDescriptor
func (Order) EnumDescriptor
deprecated
added in
v0.15.0
func (Order) Number ¶ added in v0.15.0
func (x Order) Number() protoreflect.EnumNumber
func (Order) Type ¶ added in v0.15.0
func (Order) Type() protoreflect.EnumType
type Patch ¶ added in v0.11.0
type Patch int32
Patch type for both sheet-level and field-level.
const ( Patch_PATCH_NONE Patch = 0 // 1 Sheet-level patch option "PATCH_REPLACE" // - replace whole message // // 2 Top-field patch option "PATCH_REPLACE" // - list: Clear field firstly, and then all elements of this list field // in src are appended to the corresponded list fields in dst. // - map: Clear field firstly, and then all entries of this map field in src // are copied into the corresponding map field in dst. Patch_PATCH_REPLACE Patch = 1 // Merge src into dst, which must be a message with the same descriptor. // - scalar: Populated scalar fields in src are copied to dst. // - message: Populated singular messages in src are merged into dst by // recursively calling [proto.Merge](https://pkg.go.dev/google.golang.org/protobuf/proto#Merge). // - list: The elements of every list field in src are appended to the // corresponded list fields in dst. // - map: The entries of every map field in src are copied into the // corresponding map field in dst, possibly replacing existing entries. // - unknown: The unknown fields of src are appended to the unknown // fields of dst. Patch_PATCH_MERGE Patch = 2 )
func (Patch) Descriptor ¶ added in v0.11.0
func (Patch) Descriptor() protoreflect.EnumDescriptor
func (Patch) EnumDescriptor
deprecated
added in
v0.11.0
func (Patch) Number ¶ added in v0.11.0
func (x Patch) Number() protoreflect.EnumNumber
func (Patch) Type ¶ added in v0.11.0
func (Patch) Type() protoreflect.EnumType
type Span ¶ added in v0.9.15
type Span int32
Field data span of scalar and struct.
const ( // Default: // - inner cell for scalar type: bool, string, bytes, number, and enum. // - cross cell for struct type: map-value, list-element, and struct-field. Span_SPAN_DEFAULT Span = 0 Span_SPAN_CROSS_CELL Span = 1 // The field data spans across multiple cells. Span_SPAN_INNER_CELL Span = 2 // The field data spans inside one cell. )
func (Span) Descriptor ¶ added in v0.9.15
func (Span) Descriptor() protoreflect.EnumDescriptor
func (Span) EnumDescriptor
deprecated
added in
v0.9.15
func (Span) Number ¶ added in v0.9.15
func (x Span) Number() protoreflect.EnumNumber
func (Span) Type ¶ added in v0.9.15
func (Span) Type() protoreflect.EnumType
type StructOptions ¶ added in v0.12.0
type StructOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Worksheet name.
Note string `protobuf:"bytes,2,opt,name=note,proto3" json:"note,omitempty"` // Struct type note. Maybe in another language (Chinese).
// contains filtered or unexported fields
}
func (*StructOptions) Descriptor
deprecated
added in
v0.12.0
func (*StructOptions) Descriptor() ([]byte, []int)
Deprecated: Use StructOptions.ProtoReflect.Descriptor instead.
func (*StructOptions) GetName ¶ added in v0.12.0
func (x *StructOptions) GetName() string
func (*StructOptions) GetNote ¶ added in v0.12.0
func (x *StructOptions) GetNote() string
func (*StructOptions) ProtoMessage ¶ added in v0.12.0
func (*StructOptions) ProtoMessage()
func (*StructOptions) ProtoReflect ¶ added in v0.12.0
func (x *StructOptions) ProtoReflect() protoreflect.Message
func (*StructOptions) Reset ¶ added in v0.12.0
func (x *StructOptions) Reset()
func (*StructOptions) String ¶ added in v0.12.0
func (x *StructOptions) String() string
type UnionOptions ¶ added in v0.12.0
type UnionOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Worksheet name.
Note string `protobuf:"bytes,2,opt,name=note,proto3" json:"note,omitempty"` // Oneof note, maybe in another language (Chinese).
// contains filtered or unexported fields
}
func (*UnionOptions) Descriptor
deprecated
added in
v0.12.0
func (*UnionOptions) Descriptor() ([]byte, []int)
Deprecated: Use UnionOptions.ProtoReflect.Descriptor instead.
func (*UnionOptions) GetName ¶ added in v0.12.0
func (x *UnionOptions) GetName() string
func (*UnionOptions) GetNote ¶ added in v0.12.0
func (x *UnionOptions) GetNote() string
func (*UnionOptions) ProtoMessage ¶ added in v0.12.0
func (*UnionOptions) ProtoMessage()
func (*UnionOptions) ProtoReflect ¶ added in v0.12.0
func (x *UnionOptions) ProtoReflect() protoreflect.Message
func (*UnionOptions) Reset ¶ added in v0.12.0
func (x *UnionOptions) Reset()
func (*UnionOptions) String ¶ added in v0.12.0
func (x *UnionOptions) String() string
type Vector2 ¶ added in v0.12.0
type Vector2 struct {
X float32 `protobuf:"fixed32,1,opt,name=x,proto3" json:"x,omitempty"`
Y float32 `protobuf:"fixed32,2,opt,name=y,proto3" json:"y,omitempty"`
// contains filtered or unexported fields
}
A 2D vector using float coordinates. See https://docs.godotengine.org/en/stable/classes/class_vector2.html
func (*Vector2) Descriptor
deprecated
added in
v0.12.0
func (*Vector2) ProtoMessage ¶ added in v0.12.0
func (*Vector2) ProtoMessage()
func (*Vector2) ProtoReflect ¶ added in v0.12.0
func (x *Vector2) ProtoReflect() protoreflect.Message
type Vector2I ¶ added in v0.12.0
type Vector2I struct {
X int32 `protobuf:"varint,1,opt,name=x,proto3" json:"x,omitempty"`
Y int32 `protobuf:"varint,2,opt,name=y,proto3" json:"y,omitempty"`
// contains filtered or unexported fields
}
A 2D vector using int32 coordinates. See https://docs.godotengine.org/en/stable/classes/class_vector2i.html
func (*Vector2I) Descriptor
deprecated
added in
v0.12.0
func (*Vector2I) ProtoMessage ¶ added in v0.12.0
func (*Vector2I) ProtoMessage()
func (*Vector2I) ProtoReflect ¶ added in v0.12.0
func (x *Vector2I) ProtoReflect() protoreflect.Message
type Vector3 ¶ added in v0.12.0
type Vector3 struct {
X float32 `protobuf:"fixed32,1,opt,name=x,proto3" json:"x,omitempty"`
Y float32 `protobuf:"fixed32,2,opt,name=y,proto3" json:"y,omitempty"`
Z float32 `protobuf:"fixed32,3,opt,name=z,proto3" json:"z,omitempty"`
// contains filtered or unexported fields
}
A 3D vector using float coordinates. See https://docs.godotengine.org/en/stable/classes/class_vector3.html
func (*Vector3) Descriptor
deprecated
added in
v0.12.0
func (*Vector3) ProtoMessage ¶ added in v0.12.0
func (*Vector3) ProtoMessage()
func (*Vector3) ProtoReflect ¶ added in v0.12.0
func (x *Vector3) ProtoReflect() protoreflect.Message
type Vector3I ¶ added in v0.12.0
type Vector3I struct {
X int32 `protobuf:"varint,1,opt,name=x,proto3" json:"x,omitempty"`
Y int32 `protobuf:"varint,2,opt,name=y,proto3" json:"y,omitempty"`
Z int32 `protobuf:"varint,3,opt,name=z,proto3" json:"z,omitempty"`
// contains filtered or unexported fields
}
A 3D vector using int32 coordinates. See https://docs.godotengine.org/en/stable/classes/class_vector3i.html
func (*Vector3I) Descriptor
deprecated
added in
v0.12.0
func (*Vector3I) ProtoMessage ¶ added in v0.12.0
func (*Vector3I) ProtoMessage()
func (*Vector3I) ProtoReflect ¶ added in v0.12.0
func (x *Vector3I) ProtoReflect() protoreflect.Message
type Vector4 ¶ added in v0.12.0
type Vector4 struct {
X float32 `protobuf:"fixed32,1,opt,name=x,proto3" json:"x,omitempty"`
Y float32 `protobuf:"fixed32,2,opt,name=y,proto3" json:"y,omitempty"`
Z float32 `protobuf:"fixed32,3,opt,name=z,proto3" json:"z,omitempty"`
W float32 `protobuf:"fixed32,4,opt,name=w,proto3" json:"w,omitempty"`
// contains filtered or unexported fields
}
A 4D vector using float coordinates. See https://docs.godotengine.org/en/stable/classes/class_vector4.html
func (*Vector4) Descriptor
deprecated
added in
v0.12.0
func (*Vector4) ProtoMessage ¶ added in v0.12.0
func (*Vector4) ProtoMessage()
func (*Vector4) ProtoReflect ¶ added in v0.12.0
func (x *Vector4) ProtoReflect() protoreflect.Message
type Vector4I ¶ added in v0.12.0
type Vector4I struct {
X int32 `protobuf:"varint,1,opt,name=x,proto3" json:"x,omitempty"`
Y int32 `protobuf:"varint,2,opt,name=y,proto3" json:"y,omitempty"`
Z int32 `protobuf:"varint,3,opt,name=z,proto3" json:"z,omitempty"`
W int32 `protobuf:"varint,4,opt,name=w,proto3" json:"w,omitempty"`
// contains filtered or unexported fields
}
A 4D vector using int32 coordinates. See https://docs.godotengine.org/en/stable/classes/class_vector4i.html
func (*Vector4I) Descriptor
deprecated
added in
v0.12.0
func (*Vector4I) ProtoMessage ¶ added in v0.12.0
func (*Vector4I) ProtoMessage()
func (*Vector4I) ProtoReflect ¶ added in v0.12.0
func (x *Vector4I) ProtoReflect() protoreflect.Message
type Version ¶ added in v0.14.0
type Version struct {
Str string `protobuf:"bytes,1,opt,name=str,proto3" json:"str,omitempty"` // Version in string form.
Val uint64 `protobuf:"varint,2,opt,name=val,proto3" json:"val,omitempty"` // Version in integer form.
Major uint32 `protobuf:"varint,3,opt,name=major,proto3" json:"major,omitempty"` // Major version number.
Minor uint32 `protobuf:"varint,4,opt,name=minor,proto3" json:"minor,omitempty"` // Minor version number.
Patch uint32 `protobuf:"varint,5,opt,name=patch,proto3" json:"patch,omitempty"` // Patch version number.
Others []uint32 `protobuf:"varint,6,rep,packed,name=others,proto3" json:"others,omitempty"` // Other version numbers, such as build number, resource version, and so on.
// contains filtered or unexported fields
}
Version number in [dot-decimal notation](https://en.wikipedia.org/wiki/Dot-decimal_notation). The version form is "<MAJOR>.<MINOR>.<PATCH>[.<OTHER>]...".
You can specify the version pattern as "<MAJOR_MAX>.<MINOR_MAX>.<PATCH_MAX>[.<OTHER_MAX>]...".
- Each part with suffix "MAX" represents the max decimal value of each part in the dot-decimal notation.
- Each part "XXX_MAX+1" represents the part's value occupying in an integer.
- For example, the formula for general pattern "<MAJOR_MAX>.<MINOR_MAX>.<PATCH_MAX>" is: MAJOR*(MINOR_MAX+1)*(PATCH_MAX+1) + MINOR*(PATCH_MAX+1) + PATCH
Default pattern: "255.255.255".
func (*Version) Descriptor
deprecated
added in
v0.14.0
func (*Version) ProtoMessage ¶ added in v0.14.0
func (*Version) ProtoMessage()
func (*Version) ProtoReflect ¶ added in v0.14.0
func (x *Version) ProtoReflect() protoreflect.Message
type WorkbookOptions ¶
type WorkbookOptions struct {
// filename with path, e.g.: "relative/path/BookName.suffix" (slash path)
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// book alias without suffix, e.g.: "BookAlias"
Alias string `protobuf:"bytes,2,opt,name=alias,proto3" json:"alias,omitempty"`
// Exact row number of column name definition at a worksheet.
//
// Default: 1.
Namerow int32 `protobuf:"varint,3,opt,name=namerow,proto3" json:"namerow,omitempty"`
// Exact row number of column type definition at a worksheet.
//
// Default: 2.
Typerow int32 `protobuf:"varint,4,opt,name=typerow,proto3" json:"typerow,omitempty"`
// Exact row number of column note definition at a worksheet.
//
// Default: 3.
Noterow int32 `protobuf:"varint,5,opt,name=noterow,proto3" json:"noterow,omitempty"`
// Start row number of data at a worksheet.
//
// Default: 4.
Datarow int32 `protobuf:"varint,6,opt,name=datarow,proto3" json:"datarow,omitempty"`
// The line number of column name definition in a cell. 0 means
// the whole cell.
//
// Default: 0.
Nameline int32 `protobuf:"varint,7,opt,name=nameline,proto3" json:"nameline,omitempty"`
// The line number of column type definition in a cell. 0 means
// the whole cell.
//
// Default: 0.
Typeline int32 `protobuf:"varint,8,opt,name=typeline,proto3" json:"typeline,omitempty"`
// The line number of column note definition in a cell. 0 means
// the whole cell.
//
// Default: 0.
Noteline int32 `protobuf:"varint,9,opt,name=noteline,proto3" json:"noteline,omitempty"`
// Sheet-level separator for separating:
// - incell list elements (scalar or struct).
// - incell map items.
//
// If set, it will overwrite global-level seq in options.ConfInputOption.Sep.
Sep string `protobuf:"bytes,10,opt,name=sep,proto3" json:"sep,omitempty"`
// Sheet-level subseparator for separating:
// - key-value pair of each incell map item.
// - struct fields of each incell struct list element.
//
// If set, it will overwrite global-level subseq in options.ConfInputOption.Subsep.
Subsep string `protobuf:"bytes,11,opt,name=subsep,proto3" json:"subsep,omitempty"`
// contains filtered or unexported fields
}
func (*WorkbookOptions) Descriptor
deprecated
func (*WorkbookOptions) Descriptor() ([]byte, []int)
Deprecated: Use WorkbookOptions.ProtoReflect.Descriptor instead.
func (*WorkbookOptions) GetAlias ¶ added in v0.12.0
func (x *WorkbookOptions) GetAlias() string
func (*WorkbookOptions) GetDatarow ¶ added in v0.13.0
func (x *WorkbookOptions) GetDatarow() int32
func (*WorkbookOptions) GetName ¶
func (x *WorkbookOptions) GetName() string
func (*WorkbookOptions) GetNameline ¶ added in v0.13.0
func (x *WorkbookOptions) GetNameline() int32
func (*WorkbookOptions) GetNamerow ¶ added in v0.13.0
func (x *WorkbookOptions) GetNamerow() int32
func (*WorkbookOptions) GetNoteline ¶ added in v0.13.0
func (x *WorkbookOptions) GetNoteline() int32
func (*WorkbookOptions) GetNoterow ¶ added in v0.13.0
func (x *WorkbookOptions) GetNoterow() int32
func (*WorkbookOptions) GetSep ¶ added in v0.13.0
func (x *WorkbookOptions) GetSep() string
func (*WorkbookOptions) GetSubsep ¶ added in v0.13.0
func (x *WorkbookOptions) GetSubsep() string
func (*WorkbookOptions) GetTypeline ¶ added in v0.13.0
func (x *WorkbookOptions) GetTypeline() int32
func (*WorkbookOptions) GetTyperow ¶ added in v0.13.0
func (x *WorkbookOptions) GetTyperow() int32
func (*WorkbookOptions) ProtoMessage ¶
func (*WorkbookOptions) ProtoMessage()
func (*WorkbookOptions) ProtoReflect ¶
func (x *WorkbookOptions) ProtoReflect() protoreflect.Message
func (*WorkbookOptions) Reset ¶
func (x *WorkbookOptions) Reset()
func (*WorkbookOptions) String ¶
func (x *WorkbookOptions) String() string
type WorksheetOptions ¶
type WorksheetOptions struct {
// Worksheet name
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Exact row number of column name definition at a worksheet.
//
// Default: 1.
Namerow int32 `protobuf:"varint,2,opt,name=namerow,proto3" json:"namerow,omitempty"`
// Exact row number of column type definition at a worksheet.
//
// Default: 2.
Typerow int32 `protobuf:"varint,3,opt,name=typerow,proto3" json:"typerow,omitempty"`
// Exact row number of column note definition at a worksheet.
//
// Default: 3.
Noterow int32 `protobuf:"varint,4,opt,name=noterow,proto3" json:"noterow,omitempty"`
// Start row number of data at a worksheet.
//
// Default: 4.
Datarow int32 `protobuf:"varint,5,opt,name=datarow,proto3" json:"datarow,omitempty"`
// The line number of column name definition in a cell. 0 means
// the whole cell.
//
// Default: 0.
Nameline int32 `protobuf:"varint,6,opt,name=nameline,proto3" json:"nameline,omitempty"`
// The line number of column type definition in a cell. 0 means
// the whole cell.
//
// Default: 0.
Typeline int32 `protobuf:"varint,7,opt,name=typeline,proto3" json:"typeline,omitempty"`
// The line number of column note definition in a cell. 0 means
// the whole cell.
//
// Default: 0.
Noteline int32 `protobuf:"varint,8,opt,name=noteline,proto3" json:"noteline,omitempty"`
// Sheet-level separator for separating:
// - incell list elements (scalar or struct).
// - incell map items.
//
// If set, it will overwrite global-level seq in options.ConfInputOption.Sep.
Sep string `protobuf:"bytes,9,opt,name=sep,proto3" json:"sep,omitempty"`
// Sheet-level subseparator for separating:
// - key-value pair of each incell map item.
// - struct fields of each incell struct list element.
//
// If set, it will overwrite global-level subseq in options.ConfInputOption.Subsep.
Subsep string `protobuf:"bytes,10,opt,name=subsep,proto3" json:"subsep,omitempty"`
// Nested naming of the namerow.
Nested bool `protobuf:"varint,11,opt,name=nested,proto3" json:"nested,omitempty"`
// Interchange the rows and columns of worksheet.
Transpose bool `protobuf:"varint,12,opt,name=transpose,proto3" json:"transpose,omitempty"`
// Labels are key/value pairs that are attached to sheet.
// Labels can be used to organize and to select subsets of sheets.
// For example:
// - "app:gamesvr,patch:merge" indicates app is gamesvr and patch is true.
// - "app:*" indicates all apps.
//
// This concept is much like it is in k8s, see
// https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/.
Labels map[string]string `` /* 154-byte string literal not displayed */
// Merger merge multiple workbook sheets (comma-separated) into one
// with same schema. E.g.: Item1.xlsx,Item2.xlsx,ItemAward*.xlsx.
Merger []string `protobuf:"bytes,14,rep,name=merger,proto3" json:"merger,omitempty"`
// Merge adjacent rows with the same key. If the key cell is not set,
// it will be treated the same as the nearest key above the same column.
AdjacentKey bool `protobuf:"varint,15,opt,name=adjacent_key,json=adjacentKey,proto3" json:"adjacent_key,omitempty"`
// In order to track field presence of basic types (numeric, string, bytes,
// and enums), the generated field will be labeled "optional".
//
// See https://protobuf.dev/programming-guides/field_presence/
FieldPresence bool `protobuf:"varint,16,opt,name=field_presence,json=fieldPresence,proto3" json:"field_presence,omitempty"`
// Indicate this XML sheet is a template or not. Template sheet structure will
// only be parsed based on metasheet "@TABLEAU" in comments.
Template bool `protobuf:"varint,17,opt,name=template,proto3" json:"template,omitempty"`
// Sheet mode.
Mode Mode `protobuf:"varint,18,opt,name=mode,proto3,enum=tableau.Mode" json:"mode,omitempty"`
// Scatter convert multiple workbook sheets (comma-separated) separately
// with same schema. E.g.: Item1.xlsx,Item2.xlsx,ItemAward*.xlsx.
Scatter []string `protobuf:"bytes,19,rep,name=scatter,proto3" json:"scatter,omitempty"`
// Whether all fields in this sheet are optional (field name existence).
// If set to true, then:
// - table formats (Excel/CSV): field's column can be absent.
// - document formats (XML/YAML): field's name can be absent.
Optional bool `protobuf:"varint,20,opt,name=optional,proto3" json:"optional,omitempty"`
// Sheet patch type.
Patch Patch `protobuf:"varint,21,opt,name=patch,proto3,enum=tableau.Patch" json:"patch,omitempty"`
// confgen: export JSON/Bin/Text files with parent dir created.
WithParentDir bool `protobuf:"varint,22,opt,name=with_parent_dir,json=withParentDir,proto3" json:"with_parent_dir,omitempty"`
// confgen(scatter): export JSON/Bin/Text filenames without book name prefix.
ScatterWithoutBookName bool `` /* 133-byte string literal not displayed */
// Protovalidate message-level rules. The value is a text-format
// representation of buf.validate.MessageRules, e.g.: "cel_expression:\"this.item_map.size() > 0\"".
//
// See https://github.com/bufbuild/protovalidate.
Validate string `protobuf:"bytes,24,opt,name=validate,proto3" json:"validate,omitempty"`
// //////// Loader related options below //////////
// Generate OrderedMap accessers or not.
OrderedMap bool `protobuf:"varint,50,opt,name=ordered_map,json=orderedMap,proto3" json:"ordered_map,omitempty"`
// Generate index accessers, and multiple index columns are comma-separated.
//
// # Single-column index
//
// Form: Column<ColumnX,ColumnY,...>[@IndexName]
//
// If IndexName is not set, it will be this column’s parent struct type name.
// The columns in the angle brackets `<>` specify the sorting columns, which
// the result array of same index key sort by.
//
// # Multi-column index
//
// Form: (Column1,Column2,...)<ColumnX,ColumnY,...>[@IndexName]
//
// Examples:
// - ID
// - ID<ID>@Item
// - (ID,Type)
// - (ID,Type)@Item
// - (ID,Type)<ID>@Item
// - (ID,Type)<Type,Priority>@Item
// - ID, (ID,Type)@Item
Index []string `protobuf:"bytes,51,rep,name=index,proto3" json:"index,omitempty"`
// Specify loader language options.
// Valid keys are: OrderedMap, Index, OrderedIndex.
// Different kvs must be seperated by ',' and one key value must be seperated
// by ':'. If one key doesn't exist in map, it means that this loader option
// is supported in all languages. Valid values are all combinations of "cpp",
// "go" and "csharp" with ' ' as seperator.
//
// Examples:
// - OrderedMap:cpp,Index:cpp go // ordered map supported in cpp, index
// supported in cpp and go
// - OrderedMap:cpp // ordered map supported in cpp, index supported in all
// languages
LangOptions map[string]string `` /* 183-byte string literal not displayed */
// Generate OrderedIndex accessers, and multiple index columns are comma-separated.
// Formats are same with index.
OrderedIndex []string `protobuf:"bytes,53,rep,name=ordered_index,json=orderedIndex,proto3" json:"ordered_index,omitempty"`
// contains filtered or unexported fields
}
func (*WorksheetOptions) Descriptor
deprecated
func (*WorksheetOptions) Descriptor() ([]byte, []int)
Deprecated: Use WorksheetOptions.ProtoReflect.Descriptor instead.
func (*WorksheetOptions) GetAdjacentKey ¶ added in v0.9.15
func (x *WorksheetOptions) GetAdjacentKey() bool
func (*WorksheetOptions) GetDatarow ¶
func (x *WorksheetOptions) GetDatarow() int32
func (*WorksheetOptions) GetFieldPresence ¶ added in v0.9.17
func (x *WorksheetOptions) GetFieldPresence() bool
func (*WorksheetOptions) GetIndex ¶ added in v0.9.15
func (x *WorksheetOptions) GetIndex() []string
func (*WorksheetOptions) GetLabels ¶ added in v0.12.0
func (x *WorksheetOptions) GetLabels() map[string]string
func (*WorksheetOptions) GetLangOptions ¶ added in v0.12.0
func (x *WorksheetOptions) GetLangOptions() map[string]string
func (*WorksheetOptions) GetMerger ¶ added in v0.9.13
func (x *WorksheetOptions) GetMerger() []string
func (*WorksheetOptions) GetMode ¶ added in v0.10.7
func (x *WorksheetOptions) GetMode() Mode
func (*WorksheetOptions) GetName ¶
func (x *WorksheetOptions) GetName() string
func (*WorksheetOptions) GetNameline ¶
func (x *WorksheetOptions) GetNameline() int32
func (*WorksheetOptions) GetNamerow ¶
func (x *WorksheetOptions) GetNamerow() int32
func (*WorksheetOptions) GetNested ¶
func (x *WorksheetOptions) GetNested() bool
func (*WorksheetOptions) GetNoteline ¶ added in v0.13.0
func (x *WorksheetOptions) GetNoteline() int32
func (*WorksheetOptions) GetNoterow ¶
func (x *WorksheetOptions) GetNoterow() int32
func (*WorksheetOptions) GetOptional ¶ added in v0.11.0
func (x *WorksheetOptions) GetOptional() bool
func (*WorksheetOptions) GetOrderedIndex ¶ added in v0.14.2
func (x *WorksheetOptions) GetOrderedIndex() []string
func (*WorksheetOptions) GetOrderedMap ¶ added in v0.9.1
func (x *WorksheetOptions) GetOrderedMap() bool
func (*WorksheetOptions) GetPatch ¶ added in v0.11.0
func (x *WorksheetOptions) GetPatch() Patch
func (*WorksheetOptions) GetScatter ¶ added in v0.10.7
func (x *WorksheetOptions) GetScatter() []string
func (*WorksheetOptions) GetScatterWithoutBookName ¶ added in v0.12.0
func (x *WorksheetOptions) GetScatterWithoutBookName() bool
func (*WorksheetOptions) GetSep ¶ added in v0.9.1
func (x *WorksheetOptions) GetSep() string
func (*WorksheetOptions) GetSubsep ¶ added in v0.9.1
func (x *WorksheetOptions) GetSubsep() string
func (*WorksheetOptions) GetTemplate ¶ added in v0.10.6
func (x *WorksheetOptions) GetTemplate() bool
func (*WorksheetOptions) GetTranspose ¶
func (x *WorksheetOptions) GetTranspose() bool
func (*WorksheetOptions) GetTypeline ¶
func (x *WorksheetOptions) GetTypeline() int32
func (*WorksheetOptions) GetTyperow ¶
func (x *WorksheetOptions) GetTyperow() int32
func (*WorksheetOptions) GetValidate ¶ added in v0.16.0
func (x *WorksheetOptions) GetValidate() string
func (*WorksheetOptions) GetWithParentDir ¶ added in v0.12.0
func (x *WorksheetOptions) GetWithParentDir() bool
func (*WorksheetOptions) ProtoMessage ¶
func (*WorksheetOptions) ProtoMessage()
func (*WorksheetOptions) ProtoReflect ¶
func (x *WorksheetOptions) ProtoReflect() protoreflect.Message
func (*WorksheetOptions) Reset ¶
func (x *WorksheetOptions) Reset()
func (*WorksheetOptions) String ¶
func (x *WorksheetOptions) String() string