Documentation
¶
Index ¶
- Variables
- type EnumDescriptor
- type EnumDescriptor_Value
- func (*EnumDescriptor_Value) Descriptor() ([]byte, []int)deprecated
- func (x *EnumDescriptor_Value) GetAlias() string
- func (x *EnumDescriptor_Value) GetName() string
- func (x *EnumDescriptor_Value) GetNumber() int32
- func (*EnumDescriptor_Value) ProtoMessage()
- func (x *EnumDescriptor_Value) ProtoReflect() protoreflect.Message
- func (x *EnumDescriptor_Value) Reset()
- func (x *EnumDescriptor_Value) String() string
- type EnumOptions
- type EnumValueOptions
- type Field
- func (*Field) Descriptor() ([]byte, []int)deprecated
- func (x *Field) GetAlias() string
- func (x *Field) GetFields() []*Field
- func (x *Field) GetFullType() string
- func (x *Field) GetListEntry() *Field_ListEntry
- func (x *Field) GetMapEntry() *Field_MapEntry
- func (x *Field) GetName() string
- func (x *Field) GetNumber() int32
- func (x *Field) GetOptions() *FieldOptions
- func (x *Field) GetPredefined() bool
- func (x *Field) GetType() string
- func (*Field) ProtoMessage()
- func (x *Field) ProtoReflect() protoreflect.Message
- func (x *Field) Reset()
- func (x *Field) 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) GetSep() string
- func (x *FieldOptions) GetSpan() Span
- func (x *FieldOptions) GetSubsep() string
- 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) 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) GetPatch() Patch
- func (x *FieldProp) GetPresent() bool
- func (x *FieldProp) GetRange() string
- func (x *FieldProp) GetRefer() string
- func (x *FieldProp) GetSequence() int64
- func (x *FieldProp) GetSize() uint32
- func (x *FieldProp) GetUnique() bool
- func (*FieldProp) ProtoMessage()
- func (x *FieldProp) ProtoReflect() protoreflect.Message
- func (x *FieldProp) Reset()
- func (x *FieldProp) String() string
- type Field_ListEntry
- func (*Field_ListEntry) Descriptor() ([]byte, []int)deprecated
- func (x *Field_ListEntry) GetElemFullType() string
- func (x *Field_ListEntry) GetElemType() string
- func (*Field_ListEntry) ProtoMessage()
- func (x *Field_ListEntry) ProtoReflect() protoreflect.Message
- func (x *Field_ListEntry) Reset()
- func (x *Field_ListEntry) String() string
- type Field_MapEntry
- func (*Field_MapEntry) Descriptor() ([]byte, []int)deprecated
- func (x *Field_MapEntry) GetKeyType() string
- func (x *Field_MapEntry) GetValueFullType() string
- func (x *Field_MapEntry) GetValueType() string
- func (*Field_MapEntry) ProtoMessage()
- func (x *Field_MapEntry) ProtoReflect() protoreflect.Message
- func (x *Field_MapEntry) Reset()
- func (x *Field_MapEntry) String() string
- type Form
- type Layout
- type Metabook
- type Metasheet
- func (*Metasheet) Descriptor() ([]byte, []int)deprecated
- func (x *Metasheet) GetAdjacentKey() bool
- func (x *Metasheet) GetAlias() string
- func (x *Metasheet) GetDatarow() int32
- func (x *Metasheet) GetFieldPresence() bool
- func (x *Metasheet) GetIndex() string
- func (x *Metasheet) GetMerger() []string
- func (x *Metasheet) GetMode() Mode
- func (x *Metasheet) GetNameline() int32
- func (x *Metasheet) GetNamerow() int32
- func (x *Metasheet) GetNested() bool
- func (x *Metasheet) GetNoterow() int32
- func (x *Metasheet) GetOptional() bool
- func (x *Metasheet) GetOrderedMap() bool
- func (x *Metasheet) GetPatch() Patch
- func (x *Metasheet) GetScatter() []string
- func (x *Metasheet) GetSep() string
- func (x *Metasheet) GetSheet() string
- func (x *Metasheet) GetSubsep() string
- func (x *Metasheet) GetTemplate() bool
- func (x *Metasheet) GetTranspose() bool
- func (x *Metasheet) GetTypeline() int32
- func (x *Metasheet) GetTyperow() int32
- func (*Metasheet) ProtoMessage()
- func (x *Metasheet) ProtoReflect() protoreflect.Message
- func (x *Metasheet) Reset()
- func (x *Metasheet) String() string
- type Mode
- type OneofOptions
- func (*OneofOptions) Descriptor() ([]byte, []int)deprecated
- func (x *OneofOptions) GetField() string
- func (x *OneofOptions) GetName() string
- func (*OneofOptions) ProtoMessage()
- func (x *OneofOptions) ProtoReflect() protoreflect.Message
- func (x *OneofOptions) Reset()
- func (x *OneofOptions) String() string
- type Patch
- type Span
- type StructDescriptor
- func (*StructDescriptor) Descriptor() ([]byte, []int)deprecated
- func (x *StructDescriptor) GetFields() []*StructDescriptor_Field
- func (*StructDescriptor) ProtoMessage()
- func (x *StructDescriptor) ProtoReflect() protoreflect.Message
- func (x *StructDescriptor) Reset()
- func (x *StructDescriptor) String() string
- type StructDescriptor_Field
- func (*StructDescriptor_Field) Descriptor() ([]byte, []int)deprecated
- func (x *StructDescriptor_Field) GetName() string
- func (x *StructDescriptor_Field) GetType() string
- func (*StructDescriptor_Field) ProtoMessage()
- func (x *StructDescriptor_Field) ProtoReflect() protoreflect.Message
- func (x *StructDescriptor_Field) Reset()
- func (x *StructDescriptor_Field) String() string
- type UnionDescriptor
- func (*UnionDescriptor) Descriptor() ([]byte, []int)deprecated
- func (x *UnionDescriptor) GetValues() []*UnionDescriptor_Value
- func (*UnionDescriptor) ProtoMessage()
- func (x *UnionDescriptor) ProtoReflect() protoreflect.Message
- func (x *UnionDescriptor) Reset()
- func (x *UnionDescriptor) String() string
- type UnionDescriptor_Value
- func (*UnionDescriptor_Value) Descriptor() ([]byte, []int)deprecated
- func (x *UnionDescriptor_Value) GetAlias() string
- func (x *UnionDescriptor_Value) GetFields() []string
- func (x *UnionDescriptor_Value) GetName() string
- func (x *UnionDescriptor_Value) GetNumber() int32
- func (*UnionDescriptor_Value) ProtoMessage()
- func (x *UnionDescriptor_Value) ProtoReflect() protoreflect.Message
- func (x *UnionDescriptor_Value) Reset()
- func (x *UnionDescriptor_Value) String() string
- type Workbook
- func (*Workbook) Descriptor() ([]byte, []int)deprecated
- func (x *Workbook) GetAlias() string
- func (x *Workbook) GetImports() map[string]int32
- func (x *Workbook) GetName() string
- func (x *Workbook) GetOptions() *WorkbookOptions
- func (x *Workbook) GetWorksheets() []*Worksheet
- func (*Workbook) ProtoMessage()
- func (x *Workbook) ProtoReflect() protoreflect.Message
- func (x *Workbook) Reset()
- func (x *Workbook) String() string
- type WorkbookOptions
- type Worksheet
- func (*Worksheet) Descriptor() ([]byte, []int)deprecated
- func (x *Worksheet) GetFields() []*Field
- func (x *Worksheet) GetName() string
- func (x *Worksheet) GetOptions() *WorksheetOptions
- func (*Worksheet) ProtoMessage()
- func (x *Worksheet) ProtoReflect() protoreflect.Message
- func (x *Worksheet) Reset()
- func (x *Worksheet) 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) 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) GetNoterow() int32
- func (x *WorksheetOptions) GetOptional() bool
- func (x *WorksheetOptions) GetOrderedMap() bool
- func (x *WorksheetOptions) GetPatch() Patch
- func (x *WorksheetOptions) GetScatter() []string
- func (x *WorksheetOptions) GetSep() string
- func (x *WorksheetOptions) GetSubsep() string
- func (x *WorksheetOptions) GetTags() string
- func (x *WorksheetOptions) GetTemplate() bool
- func (x *WorksheetOptions) GetTranspose() bool
- func (x *WorksheetOptions) GetTypeline() int32
- func (x *WorksheetOptions) GetTyperow() int32
- 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_UE_CSV", 2: "MODE_UE_JSON", 3: "MODE_ENUM_TYPE", 4: "MODE_STRUCT_TYPE", 5: "MODE_UNION_TYPE", } Mode_value = map[string]int32{ "MODE_DEFAULT": 0, "MODE_UE_CSV": 1, "MODE_UE_JSON": 2, "MODE_ENUM_TYPE": 3, "MODE_STRUCT_TYPE": 4, "MODE_UNION_TYPE": 5, } )
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 ( // optional tableau.WorksheetOptions worksheet = 50000; E_Worksheet = &file_tableau_protobuf_tableau_proto_extTypes[1] // optional bool union = 50001; E_Union = &file_tableau_protobuf_tableau_proto_extTypes[2] )
Extension fields to descriptorpb.MessageOptions.
var (
// optional tableau.EnumOptions etype = 50000;
E_Etype = &file_tableau_protobuf_tableau_proto_extTypes[4]
)
Extension fields to descriptorpb.EnumOptions.
var (
// optional tableau.EnumValueOptions evalue = 50000;
E_Evalue = &file_tableau_protobuf_tableau_proto_extTypes[5]
)
Extension fields to descriptorpb.EnumValueOptions.
var (
// optional tableau.FieldOptions field = 50000;
E_Field = &file_tableau_protobuf_tableau_proto_extTypes[3]
)
Extension fields to descriptorpb.FieldOptions.
var (
// optional tableau.OneofOptions oneof = 50000;
E_Oneof = &file_tableau_protobuf_tableau_proto_extTypes[6]
)
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_metabook_proto protoreflect.FileDescriptor
var File_tableau_protobuf_tableau_proto protoreflect.FileDescriptor
var File_tableau_protobuf_workbook_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type EnumDescriptor ¶ added in v0.11.0
type EnumDescriptor struct {
Values []*EnumDescriptor_Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
EnumDescriptor represents enum type definition in sheet.
func (*EnumDescriptor) Descriptor
deprecated
added in
v0.11.0
func (*EnumDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use EnumDescriptor.ProtoReflect.Descriptor instead.
func (*EnumDescriptor) GetValues ¶ added in v0.11.0
func (x *EnumDescriptor) GetValues() []*EnumDescriptor_Value
func (*EnumDescriptor) ProtoMessage ¶ added in v0.11.0
func (*EnumDescriptor) ProtoMessage()
func (*EnumDescriptor) ProtoReflect ¶ added in v0.11.0
func (x *EnumDescriptor) ProtoReflect() protoreflect.Message
func (*EnumDescriptor) Reset ¶ added in v0.11.0
func (x *EnumDescriptor) Reset()
func (*EnumDescriptor) String ¶ added in v0.11.0
func (x *EnumDescriptor) String() string
type EnumDescriptor_Value ¶ added in v0.11.0
type EnumDescriptor_Value struct {
Number *int32 `protobuf:"varint,1,opt,name=number,proto3,oneof" json:"number,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
Alias string `protobuf:"bytes,3,opt,name=alias,proto3" json:"alias,omitempty"`
// contains filtered or unexported fields
}
func (*EnumDescriptor_Value) Descriptor
deprecated
added in
v0.11.0
func (*EnumDescriptor_Value) Descriptor() ([]byte, []int)
Deprecated: Use EnumDescriptor_Value.ProtoReflect.Descriptor instead.
func (*EnumDescriptor_Value) GetAlias ¶ added in v0.11.0
func (x *EnumDescriptor_Value) GetAlias() string
func (*EnumDescriptor_Value) GetName ¶ added in v0.11.0
func (x *EnumDescriptor_Value) GetName() string
func (*EnumDescriptor_Value) GetNumber ¶ added in v0.11.0
func (x *EnumDescriptor_Value) GetNumber() int32
func (*EnumDescriptor_Value) ProtoMessage ¶ added in v0.11.0
func (*EnumDescriptor_Value) ProtoMessage()
func (*EnumDescriptor_Value) ProtoReflect ¶ added in v0.11.0
func (x *EnumDescriptor_Value) ProtoReflect() protoreflect.Message
func (*EnumDescriptor_Value) Reset ¶ added in v0.11.0
func (x *EnumDescriptor_Value) Reset()
func (*EnumDescriptor_Value) String ¶ added in v0.11.0
func (x *EnumDescriptor_Value) String() string
type EnumOptions ¶
type EnumOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Alias.
// 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) 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"` // Alias.
// 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) 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 Field ¶
type Field struct {
// Field tag number
// Note: only for enum/struct/union type definition in sheet
Number int32 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
Alias string `protobuf:"bytes,3,opt,name=alias,proto3" json:"alias,omitempty"`
Type string `protobuf:"bytes,4,opt,name=type,proto3" json:"type,omitempty"`
FullType string `protobuf:"bytes,5,opt,name=full_type,json=fullType,proto3" json:"full_type,omitempty"`
ListEntry *Field_ListEntry `protobuf:"bytes,6,opt,name=list_entry,json=listEntry,proto3" json:"list_entry,omitempty"`
MapEntry *Field_MapEntry `protobuf:"bytes,7,opt,name=map_entry,json=mapEntry,proto3" json:"map_entry,omitempty"`
// Indicate this field's related type is predefined.
// - enum: enum type
// - struct: message type
// - list: list's element type
// - map: map's value type
Predefined bool `protobuf:"varint,8,opt,name=predefined,proto3" json:"predefined,omitempty"`
Options *FieldOptions `protobuf:"bytes,9,opt,name=options,proto3" json:"options,omitempty"`
// This field can be struct, list or map if sub fields's length is not 0.
Fields []*Field `protobuf:"bytes,10,rep,name=fields,proto3" json:"fields,omitempty"`
// contains filtered or unexported fields
}
func (*Field) Descriptor
deprecated
func (*Field) GetFullType ¶ added in v0.9.17
func (*Field) GetListEntry ¶ added in v0.9.17
func (x *Field) GetListEntry() *Field_ListEntry
func (*Field) GetMapEntry ¶
func (x *Field) GetMapEntry() *Field_MapEntry
func (*Field) GetOptions ¶
func (x *Field) GetOptions() *FieldOptions
func (*Field) GetPredefined ¶ added in v0.9.15
func (*Field) ProtoMessage ¶
func (*Field) ProtoMessage()
func (*Field) ProtoReflect ¶
func (x *Field) ProtoReflect() protoreflect.Message
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) other than variable name (English).
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.
Sep string `protobuf:"bytes,6,opt,name=sep,proto3" json:"sep,omitempty"` // NOT USED yet. Default: ",".
Subsep string `protobuf:"bytes,7,opt,name=subsep,proto3" json:"subsep,omitempty"` // NOT USED yet. Default: ":".
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) GetSep ¶
func (x *FieldOptions) GetSep() string
func (*FieldOptions) GetSpan ¶ added in v0.9.15
func (x *FieldOptions) GetSpan() Span
func (*FieldOptions) GetSubsep ¶
func (x *FieldOptions) GetSubsep() string
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"`
// contains filtered or unexported fields
}
func (*FieldProp) Descriptor
deprecated
added in
v0.9.1
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) GetPresent ¶ added in v0.11.0
func (*FieldProp) GetSequence ¶ added in v0.9.17
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 Field_ListEntry ¶ added in v0.9.17
type Field_ListEntry struct {
ElemType string `protobuf:"bytes,1,opt,name=elem_type,json=elemType,proto3" json:"elem_type,omitempty"`
ElemFullType string `protobuf:"bytes,2,opt,name=elem_full_type,json=elemFullType,proto3" json:"elem_full_type,omitempty"`
// contains filtered or unexported fields
}
func (*Field_ListEntry) Descriptor
deprecated
added in
v0.9.17
func (*Field_ListEntry) Descriptor() ([]byte, []int)
Deprecated: Use Field_ListEntry.ProtoReflect.Descriptor instead.
func (*Field_ListEntry) GetElemFullType ¶ added in v0.9.17
func (x *Field_ListEntry) GetElemFullType() string
func (*Field_ListEntry) GetElemType ¶ added in v0.9.17
func (x *Field_ListEntry) GetElemType() string
func (*Field_ListEntry) ProtoMessage ¶ added in v0.9.17
func (*Field_ListEntry) ProtoMessage()
func (*Field_ListEntry) ProtoReflect ¶ added in v0.9.17
func (x *Field_ListEntry) ProtoReflect() protoreflect.Message
func (*Field_ListEntry) Reset ¶ added in v0.9.17
func (x *Field_ListEntry) Reset()
func (*Field_ListEntry) String ¶ added in v0.9.17
func (x *Field_ListEntry) String() string
type Field_MapEntry ¶ added in v0.9.17
type Field_MapEntry struct {
KeyType string `protobuf:"bytes,1,opt,name=key_type,json=keyType,proto3" json:"key_type,omitempty"`
ValueType string `protobuf:"bytes,2,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
ValueFullType string `protobuf:"bytes,3,opt,name=value_full_type,json=valueFullType,proto3" json:"value_full_type,omitempty"`
// contains filtered or unexported fields
}
func (*Field_MapEntry) Descriptor
deprecated
added in
v0.9.17
func (*Field_MapEntry) Descriptor() ([]byte, []int)
Deprecated: Use Field_MapEntry.ProtoReflect.Descriptor instead.
func (*Field_MapEntry) GetKeyType ¶ added in v0.9.17
func (x *Field_MapEntry) GetKeyType() string
func (*Field_MapEntry) GetValueFullType ¶ added in v0.9.17
func (x *Field_MapEntry) GetValueFullType() string
func (*Field_MapEntry) GetValueType ¶ added in v0.9.17
func (x *Field_MapEntry) GetValueType() string
func (*Field_MapEntry) ProtoMessage ¶ added in v0.9.17
func (*Field_MapEntry) ProtoMessage()
func (*Field_MapEntry) ProtoReflect ¶ added in v0.9.17
func (x *Field_MapEntry) ProtoReflect() protoreflect.Message
func (*Field_MapEntry) Reset ¶ added in v0.9.17
func (x *Field_MapEntry) Reset()
func (*Field_MapEntry) String ¶ added in v0.9.17
func (x *Field_MapEntry) String() string
type Form ¶ added in v0.10.7
type Form int32
Cell data form.
const ( Form_FORM_DEFAULT Form = 0 // Default form which confgen parser defines. 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 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 Metabook ¶ added in v0.10.6
type Metabook struct {
MetasheetMap map[string]*Metasheet `` /* 185-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*Metabook) Descriptor
deprecated
added in
v0.10.6
func (*Metabook) GetMetasheetMap ¶ added in v0.10.6
func (*Metabook) ProtoMessage ¶ added in v0.10.6
func (*Metabook) ProtoMessage()
func (*Metabook) ProtoReflect ¶ added in v0.10.6
func (x *Metabook) ProtoReflect() protoreflect.Message
type Metasheet ¶ added in v0.10.6
type Metasheet struct {
Sheet string `protobuf:"bytes,1,opt,name=sheet,proto3" json:"sheet,omitempty"`
Alias string `protobuf:"bytes,2,opt,name=alias,proto3" json:"alias,omitempty"`
Namerow int32 `protobuf:"varint,3,opt,name=namerow,proto3" json:"namerow,omitempty"`
Typerow int32 `protobuf:"varint,4,opt,name=typerow,proto3" json:"typerow,omitempty"`
Noterow int32 `protobuf:"varint,5,opt,name=noterow,proto3" json:"noterow,omitempty"`
Datarow int32 `protobuf:"varint,6,opt,name=datarow,proto3" json:"datarow,omitempty"`
Nameline int32 `protobuf:"varint,7,opt,name=nameline,proto3" json:"nameline,omitempty"`
Typeline int32 `protobuf:"varint,8,opt,name=typeline,proto3" json:"typeline,omitempty"`
Transpose bool `protobuf:"varint,9,opt,name=transpose,proto3" json:"transpose,omitempty"`
// nested naming of namerow
Nested bool `protobuf:"varint,10,opt,name=nested,proto3" json:"nested,omitempty"`
Sep string `protobuf:"bytes,11,opt,name=sep,proto3" json:"sep,omitempty"`
Subsep string `protobuf:"bytes,12,opt,name=subsep,proto3" json:"subsep,omitempty"`
// merge multiple sheets with same schema to one.
// each element is:
// - a workbook name or Glob(https://pkg.go.dev/path/filepath#Glob) to merge (relative to this workbook): <Workbook>,
// then the sheet name is the same as this sheet.
// - or a workbook name (relative to this workbook) with a worksheet name: <Workbook>#<Worksheet>.
Merger []string `protobuf:"bytes,13,rep,name=merger,proto3" json:"merger,omitempty"`
// Tableau will merge adjacent rows with the same key. If the key cell is not set,
// it will be treated as the same as the most nearest key above the same column.
//
// This option is only useful for map or keyed-list.
AdjacentKey bool `protobuf:"varint,14,opt,name=adjacent_key,json=adjacentKey,proto3" json:"adjacent_key,omitempty"`
// Field presence is the notion of whether a protobuf field has a value. If set as true,
// in order to track presence for basic types (numeric, string, bytes, and enums), the
// generated .proto will add the `optional` label to them.
//
// Singular proto3 fields of basic types (numeric, string, bytes, and enums) which are defined
// with the optional label have explicit presence, like proto2 (this feature is enabled by default
// as release 3.15). Refer: https://github.com/protocolbuffers/protobuf/blob/main/docs/field_presence.md
FieldPresence bool `protobuf:"varint,15,opt,name=field_presence,json=fieldPresence,proto3" json:"field_presence,omitempty"`
// declares if sheet is a template config, which only generates protobuf IDL and not generates json data.
// NOTE: currently only used for XML protogen.
Template bool `protobuf:"varint,16,opt,name=template,proto3" json:"template,omitempty"`
// Sheet mode.
Mode Mode `protobuf:"varint,17,opt,name=mode,proto3,enum=tableau.Mode" json:"mode,omitempty"`
// Scatter converts sheets separately with same schema.
// each element is:
// - a workbook name or Glob(https://pkg.go.dev/path/filepath#Glob) which is relative to this workbook: <Workbook>,
// then the sheet name is the same as this sheet.
// - or a workbook name which is relative to this workbook with a worksheet name: <Workbook>#<Worksheet>.
Scatter []string `protobuf:"bytes,18,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,19,opt,name=optional,proto3" json:"optional,omitempty"`
// Sheet patch type.
Patch Patch `protobuf:"varint,20,opt,name=patch,proto3,enum=tableau.Patch" json:"patch,omitempty"`
// //////// Loader related options below //////////
// Generate ordered map accessers
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.
// Format: <ColumnName>[@IndexName], if IndexName is not set, it will be this
// column’s parent struct type name.
//
// Composite indexes (or multicolumn indexes) are in the form: ([column1, column2, column3,...])[@IndexName]
//
// Examples:
// - ID
// - ID@Item
// - (ID,Type)
// - (ID,Type)@Item
// - ID, (ID,Type)@Item
//
// Generated APIs are:
//
// C++:
// - const std::vector<const STRUCT_TYPE*>& Find<IndexName>(INDEX_TYPE index) const;
// - const STRUCT_TYPE* FindFirst<IndexName>(INDEX_TYPE index);
Index string `protobuf:"bytes,51,opt,name=index,proto3" json:"index,omitempty"`
// contains filtered or unexported fields
}
func (*Metasheet) Descriptor
deprecated
added in
v0.10.6
func (*Metasheet) GetAdjacentKey ¶ added in v0.10.6
func (*Metasheet) GetDatarow ¶ added in v0.10.6
func (*Metasheet) GetFieldPresence ¶ added in v0.10.6
func (*Metasheet) GetNameline ¶ added in v0.10.6
func (*Metasheet) GetNamerow ¶ added in v0.10.6
func (*Metasheet) GetNoterow ¶ added in v0.10.6
func (*Metasheet) GetOptional ¶ added in v0.11.0
func (*Metasheet) GetOrderedMap ¶ added in v0.10.6
func (*Metasheet) GetScatter ¶ added in v0.10.7
func (*Metasheet) GetTemplate ¶ added in v0.10.6
func (*Metasheet) GetTranspose ¶ added in v0.10.6
func (*Metasheet) GetTypeline ¶ added in v0.10.6
func (*Metasheet) GetTyperow ¶ added in v0.10.6
func (*Metasheet) ProtoMessage ¶ added in v0.10.6
func (*Metasheet) ProtoMessage()
func (*Metasheet) ProtoReflect ¶ added in v0.10.6
func (x *Metasheet) ProtoReflect() protoreflect.Message
type Mode ¶ added in v0.10.7
type Mode int32
Sheet mode.
const ( Mode_MODE_DEFAULT Mode = 0 // Default mode. // UE DataTable references: // - https://docs.unrealengine.com/5.1/en-US/data-driven-gameplay-elements-in-unreal-engine/ // - https://docs.unrealengine.com/5.1/en-US/BlueprintAPI/EditorScripting/DataTable/ Mode_MODE_UE_CSV Mode = 1 // CSV format of UE DataTable. Mode_MODE_UE_JSON Mode = 2 // JSON format of UE DataTable. Mode_MODE_ENUM_TYPE Mode = 3 // Enum type definition in sheet. Mode_MODE_STRUCT_TYPE Mode = 4 // Struct type definition in sheet. Mode_MODE_UNION_TYPE Mode = 5 // Union type definition in sheet. )
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"` // Alias. NOT USED currently.
Field string `protobuf:"bytes,2,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) 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 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. For patch option in sheet-level: `replace` all fields' value // 2. For patch option in field-level: `replace` specified field's value Patch_PATCH_REPLACE Patch = 1 // 1. For patch option in sheet-level: // 1. top none-map field (field value): // - `replace`: if field present in both **main** and **patch** sheet // 2. top map field patch (key-value pair): // - `add`: if key not exists in **main** sheet // - `replace`: if key exists in both **main** and **patch** sheet // // 2. For patch option in field-level: NOT supported yet! 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 StructDescriptor ¶ added in v0.11.0
type StructDescriptor struct {
Fields []*StructDescriptor_Field `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"`
// contains filtered or unexported fields
}
StructDescriptor represents struct type definition in sheet.
func (*StructDescriptor) Descriptor
deprecated
added in
v0.11.0
func (*StructDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use StructDescriptor.ProtoReflect.Descriptor instead.
func (*StructDescriptor) GetFields ¶ added in v0.11.0
func (x *StructDescriptor) GetFields() []*StructDescriptor_Field
func (*StructDescriptor) ProtoMessage ¶ added in v0.11.0
func (*StructDescriptor) ProtoMessage()
func (*StructDescriptor) ProtoReflect ¶ added in v0.11.0
func (x *StructDescriptor) ProtoReflect() protoreflect.Message
func (*StructDescriptor) Reset ¶ added in v0.11.0
func (x *StructDescriptor) Reset()
func (*StructDescriptor) String ¶ added in v0.11.0
func (x *StructDescriptor) String() string
type StructDescriptor_Field ¶ added in v0.11.0
type StructDescriptor_Field struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// contains filtered or unexported fields
}
func (*StructDescriptor_Field) Descriptor
deprecated
added in
v0.11.0
func (*StructDescriptor_Field) Descriptor() ([]byte, []int)
Deprecated: Use StructDescriptor_Field.ProtoReflect.Descriptor instead.
func (*StructDescriptor_Field) GetName ¶ added in v0.11.0
func (x *StructDescriptor_Field) GetName() string
func (*StructDescriptor_Field) GetType ¶ added in v0.11.0
func (x *StructDescriptor_Field) GetType() string
func (*StructDescriptor_Field) ProtoMessage ¶ added in v0.11.0
func (*StructDescriptor_Field) ProtoMessage()
func (*StructDescriptor_Field) ProtoReflect ¶ added in v0.11.0
func (x *StructDescriptor_Field) ProtoReflect() protoreflect.Message
func (*StructDescriptor_Field) Reset ¶ added in v0.11.0
func (x *StructDescriptor_Field) Reset()
func (*StructDescriptor_Field) String ¶ added in v0.11.0
func (x *StructDescriptor_Field) String() string
type UnionDescriptor ¶ added in v0.11.0
type UnionDescriptor struct {
Values []*UnionDescriptor_Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
UnionDescriptor represents union type definition in sheet.
func (*UnionDescriptor) Descriptor
deprecated
added in
v0.11.0
func (*UnionDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use UnionDescriptor.ProtoReflect.Descriptor instead.
func (*UnionDescriptor) GetValues ¶ added in v0.11.0
func (x *UnionDescriptor) GetValues() []*UnionDescriptor_Value
func (*UnionDescriptor) ProtoMessage ¶ added in v0.11.0
func (*UnionDescriptor) ProtoMessage()
func (*UnionDescriptor) ProtoReflect ¶ added in v0.11.0
func (x *UnionDescriptor) ProtoReflect() protoreflect.Message
func (*UnionDescriptor) Reset ¶ added in v0.11.0
func (x *UnionDescriptor) Reset()
func (*UnionDescriptor) String ¶ added in v0.11.0
func (x *UnionDescriptor) String() string
type UnionDescriptor_Value ¶ added in v0.11.0
type UnionDescriptor_Value struct {
Number *int32 `protobuf:"varint,1,opt,name=number,proto3,oneof" json:"number,omitempty"`
// This is message type name, and the corresponding enum value name
// is generated as: "TYPE_" + strcase.ToScreamingSnake(name).
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
Alias string `protobuf:"bytes,3,opt,name=alias,proto3" json:"alias,omitempty"`
Fields []string `protobuf:"bytes,4,rep,name=fields,proto3" json:"fields,omitempty"`
// contains filtered or unexported fields
}
func (*UnionDescriptor_Value) Descriptor
deprecated
added in
v0.11.0
func (*UnionDescriptor_Value) Descriptor() ([]byte, []int)
Deprecated: Use UnionDescriptor_Value.ProtoReflect.Descriptor instead.
func (*UnionDescriptor_Value) GetAlias ¶ added in v0.11.0
func (x *UnionDescriptor_Value) GetAlias() string
func (*UnionDescriptor_Value) GetFields ¶ added in v0.11.0
func (x *UnionDescriptor_Value) GetFields() []string
func (*UnionDescriptor_Value) GetName ¶ added in v0.11.0
func (x *UnionDescriptor_Value) GetName() string
func (*UnionDescriptor_Value) GetNumber ¶ added in v0.11.0
func (x *UnionDescriptor_Value) GetNumber() int32
func (*UnionDescriptor_Value) ProtoMessage ¶ added in v0.11.0
func (*UnionDescriptor_Value) ProtoMessage()
func (*UnionDescriptor_Value) ProtoReflect ¶ added in v0.11.0
func (x *UnionDescriptor_Value) ProtoReflect() protoreflect.Message
func (*UnionDescriptor_Value) Reset ¶ added in v0.11.0
func (x *UnionDescriptor_Value) Reset()
func (*UnionDescriptor_Value) String ¶ added in v0.11.0
func (x *UnionDescriptor_Value) String() string
type Workbook ¶
type Workbook struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // e.g.: "relative/path/bookname"
Alias string `protobuf:"bytes,2,opt,name=alias,proto3" json:"alias,omitempty"`
Options *WorkbookOptions `protobuf:"bytes,3,opt,name=options,proto3" json:"options,omitempty"`
Worksheets []*Worksheet `protobuf:"bytes,4,rep,name=worksheets,proto3" json:"worksheets,omitempty"`
Imports map[string]int32 `` // imported proto files
/* 156-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*Workbook) Descriptor
deprecated
func (*Workbook) GetImports ¶
func (*Workbook) GetOptions ¶
func (x *Workbook) GetOptions() *WorkbookOptions
func (*Workbook) GetWorksheets ¶
func (*Workbook) ProtoMessage ¶
func (*Workbook) ProtoMessage()
func (*Workbook) ProtoReflect ¶
func (x *Workbook) ProtoReflect() protoreflect.Message
type WorkbookOptions ¶
type WorkbookOptions struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Workbook name
// contains filtered or unexported fields
}
func (*WorkbookOptions) Descriptor
deprecated
func (*WorkbookOptions) Descriptor() ([]byte, []int)
Deprecated: Use WorkbookOptions.ProtoReflect.Descriptor instead.
func (*WorkbookOptions) GetName ¶
func (x *WorkbookOptions) GetName() string
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 Worksheet ¶
type Worksheet struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Options *WorksheetOptions `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
Fields []*Field `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"`
// contains filtered or unexported fields
}
func (*Worksheet) Descriptor
deprecated
func (*Worksheet) GetOptions ¶
func (x *Worksheet) GetOptions() *WorksheetOptions
func (*Worksheet) ProtoMessage ¶
func (*Worksheet) ProtoMessage()
func (*Worksheet) ProtoReflect ¶
func (x *Worksheet) ProtoReflect() protoreflect.Message
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"`
// Interchange the rows and columns of worksheet.
Transpose bool `protobuf:"varint,6,opt,name=transpose,proto3" json:"transpose,omitempty"`
// Tags for usage, e.g.: "1,2" specifying loading servers. Specially,
// "*" means all servers.
Tags string `protobuf:"bytes,7,opt,name=tags,proto3" json:"tags,omitempty"`
// The line number of column name definition in a cell. 0 means
// the whole cell.
//
// Default: 0.
Nameline int32 `protobuf:"varint,8,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,9,opt,name=typeline,proto3" json:"typeline,omitempty"`
// Nested naming of the namerow.
Nested bool `protobuf:"varint,10,opt,name=nested,proto3" json:"nested,omitempty"`
// Separator for:
// 1. separating in-cell list elements.
// 2. separating in-cell map items.
//
// Default: ",".
Sep string `protobuf:"bytes,11,opt,name=sep,proto3" json:"sep,omitempty"`
// Subseparator for separating in-cell map Key-Value pair.
//
// Default: ":".
Subsep string `protobuf:"bytes,12,opt,name=subsep,proto3" json:"subsep,omitempty"`
// Merger merge multiple workbook sheets (comma-separated) into one
// with same schema. E.g.: Item1.xlsx,Item2.xlsx,ItemAward*.xlsx.
Merger []string `protobuf:"bytes,13,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,14,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".
FieldPresence bool `protobuf:"varint,15,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,16,opt,name=template,proto3" json:"template,omitempty"`
// Sheet mode.
Mode Mode `protobuf:"varint,17,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,18,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,19,opt,name=optional,proto3" json:"optional,omitempty"`
// Sheet patch type.
Patch Patch `protobuf:"varint,20,opt,name=patch,proto3,enum=tableau.Patch" json:"patch,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.
// Format: <ColumnName>[@IndexName], if IndexName is not set, it will be this
// column’s parent struct type name.
//
// Composite indexes (or multicolumn indexes) are in the form: ([column1, column2, column3,...])[@IndexName]
//
// Examples:
// - ID
// - ID@Item
// - (ID,Type)
// - (ID,Type)@Item
// - ID, (ID,Type)@Item
Index []string `protobuf:"bytes,51,rep,name=index,proto3" json:"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) 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) GetNoterow ¶
func (x *WorksheetOptions) GetNoterow() int32
func (*WorksheetOptions) GetOptional ¶ added in v0.11.0
func (x *WorksheetOptions) GetOptional() bool
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) 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) GetTags ¶
func (x *WorksheetOptions) GetTags() 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) 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