rubyXL 3.3.33 → 3.4.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.circleci/config.yml +60 -0
- data/Gemfile +9 -8
- data/Gemfile.lock +124 -0
- data/LICENSE.txt +1 -1
- data/README.rdoc +46 -22
- data/Rakefile +29 -29
- data/VERSION +1 -1
- data/lib/rubyXL/cell.rb +2 -29
- data/lib/rubyXL/convenience_methods/cell.rb +276 -0
- data/lib/rubyXL/convenience_methods/color.rb +156 -0
- data/lib/rubyXL/convenience_methods/font.rb +63 -0
- data/lib/rubyXL/convenience_methods/workbook.rb +141 -0
- data/lib/rubyXL/convenience_methods/worksheet.rb +714 -0
- data/lib/rubyXL/convenience_methods.rb +5 -1301
- data/lib/rubyXL/objects/border.rb +0 -3
- data/lib/rubyXL/objects/calculation_chain.rb +2 -2
- data/lib/rubyXL/objects/cell_style.rb +1 -3
- data/lib/rubyXL/objects/chartsheet.rb +8 -12
- data/lib/rubyXL/objects/color.rb +3 -7
- data/lib/rubyXL/objects/column_range.rb +0 -3
- data/lib/rubyXL/objects/comments.rb +1 -4
- data/lib/rubyXL/objects/connection.rb +175 -0
- data/lib/rubyXL/objects/container_nodes.rb +1 -5
- data/lib/rubyXL/objects/content_types.rb +3 -6
- data/lib/rubyXL/objects/data_validation.rb +2 -2
- data/lib/rubyXL/objects/document_properties.rb +11 -15
- data/lib/rubyXL/objects/extensions.rb +0 -2
- data/lib/rubyXL/objects/external_links.rb +30 -8
- data/lib/rubyXL/objects/fill.rb +2 -5
- data/lib/rubyXL/objects/filters.rb +5 -7
- data/lib/rubyXL/objects/font.rb +2 -7
- data/lib/rubyXL/objects/formula.rb +3 -5
- data/lib/rubyXL/objects/ooxml_object.rb +26 -19
- data/lib/rubyXL/objects/query_table.rb +104 -0
- data/lib/rubyXL/objects/reference.rb +6 -8
- data/lib/rubyXL/objects/relationships.rb +13 -13
- data/lib/rubyXL/objects/root.rb +0 -2
- data/lib/rubyXL/objects/shared_strings.rb +3 -6
- data/lib/rubyXL/objects/sheet_common.rb +1 -3
- data/lib/rubyXL/objects/sheet_data.rb +38 -11
- data/lib/rubyXL/objects/simple_types.rb +16 -1
- data/lib/rubyXL/objects/storage.rb +51 -50
- data/lib/rubyXL/objects/stylesheet.rb +8 -15
- data/lib/rubyXL/objects/text.rb +5 -7
- data/lib/rubyXL/objects/theme.rb +5 -8
- data/lib/rubyXL/objects/workbook.rb +140 -33
- data/lib/rubyXL/objects/worksheet.rb +44 -31
- data/lib/rubyXL/parser.rb +1 -3
- data/lib/rubyXL/worksheet.rb +83 -91
- data/lib/rubyXL.rb +1 -1
- data/rdoc/README_rdoc.html +111 -126
- data/rdoc/RubyXL/AExtension.html +20 -60
- data/rdoc/RubyXL/AExtensionStorageArea.html +11 -17
- data/rdoc/RubyXL/ActiveX.html +19 -47
- data/rdoc/RubyXL/ActiveXBinary.html +11 -22
- data/rdoc/RubyXL/AdjustHandleList.html +12 -19
- data/rdoc/RubyXL/Alignment.html +12 -19
- data/rdoc/RubyXL/AlternateContent.html +11 -17
- data/rdoc/RubyXL/Authors.html +12 -19
- data/rdoc/RubyXL/AutoFilter.html +12 -19
- data/rdoc/RubyXL/AutoFilterColumn.html +12 -19
- data/rdoc/RubyXL/BinaryImageFile.html +11 -25
- data/rdoc/RubyXL/BodyProperties.html +12 -19
- data/rdoc/RubyXL/BooleanNode.html +11 -17
- data/rdoc/RubyXL/BooleanValue.html +11 -17
- data/rdoc/RubyXL/Border.html +24 -84
- data/rdoc/RubyXL/BorderEdge.html +19 -52
- data/rdoc/RubyXL/Borders.html +18 -39
- data/rdoc/RubyXL/Break.html +12 -19
- data/rdoc/RubyXL/BreakList.html +12 -19
- data/rdoc/RubyXL/CT_AdjPoint2D.html +12 -19
- data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaModulateEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +12 -19
- data/rdoc/RubyXL/CT_Backdrop.html +12 -19
- data/rdoc/RubyXL/CT_Bevel.html +12 -19
- data/rdoc/RubyXL/CT_BiLevelEffect.html +12 -19
- data/rdoc/RubyXL/CT_BlendEffect.html +12 -19
- data/rdoc/RubyXL/CT_Blip.html +12 -19
- data/rdoc/RubyXL/CT_BlipFillProperties.html +12 -19
- data/rdoc/RubyXL/CT_BlurEffect.html +12 -19
- data/rdoc/RubyXL/CT_Camera.html +12 -19
- data/rdoc/RubyXL/CT_Color.html +12 -19
- data/rdoc/RubyXL/CT_ColorChangeEffect.html +12 -19
- data/rdoc/RubyXL/CT_ColorMapping.html +12 -19
- data/rdoc/RubyXL/CT_ColorScheme.html +12 -19
- data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +12 -19
- data/rdoc/RubyXL/CT_ConnectionSite.html +12 -19
- data/rdoc/RubyXL/CT_ConnectionSiteList.html +12 -19
- data/rdoc/RubyXL/CT_DashStop.html +12 -19
- data/rdoc/RubyXL/CT_DashStopList.html +12 -19
- data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +12 -19
- data/rdoc/RubyXL/CT_DuotoneEffect.html +12 -19
- data/rdoc/RubyXL/CT_EffectContainer.html +12 -19
- data/rdoc/RubyXL/CT_EffectList.html +12 -19
- data/rdoc/RubyXL/CT_EffectReference.html +12 -19
- data/rdoc/RubyXL/CT_EffectStyleItem.html +12 -19
- data/rdoc/RubyXL/CT_EffectStyleList.html +12 -19
- data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +12 -19
- data/rdoc/RubyXL/CT_FillEffect.html +12 -19
- data/rdoc/RubyXL/CT_FillOverlayEffect.html +12 -19
- data/rdoc/RubyXL/CT_FillStyleList.html +12 -19
- data/rdoc/RubyXL/CT_FlatText.html +12 -19
- data/rdoc/RubyXL/CT_FontCollection.html +12 -19
- data/rdoc/RubyXL/CT_FontReference.html +12 -19
- data/rdoc/RubyXL/CT_GeomGuideList.html +12 -19
- data/rdoc/RubyXL/CT_GlowEffect.html +12 -19
- data/rdoc/RubyXL/CT_GradientFillProperties.html +12 -19
- data/rdoc/RubyXL/CT_GradientStop.html +12 -19
- data/rdoc/RubyXL/CT_GradientStopList.html +12 -19
- data/rdoc/RubyXL/CT_HSLEffect.html +12 -19
- data/rdoc/RubyXL/CT_HslColor.html +12 -19
- data/rdoc/RubyXL/CT_Hyperlink.html +12 -19
- data/rdoc/RubyXL/CT_InnerShadowEffect.html +12 -19
- data/rdoc/RubyXL/CT_LightRig.html +12 -19
- data/rdoc/RubyXL/CT_LineEndProperties.html +12 -19
- data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +12 -19
- data/rdoc/RubyXL/CT_LineProperties.html +12 -19
- data/rdoc/RubyXL/CT_LineStyleList.html +12 -19
- data/rdoc/RubyXL/CT_LinearShadeProperties.html +12 -19
- data/rdoc/RubyXL/CT_LuminanceEffect.html +12 -19
- data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +12 -19
- data/rdoc/RubyXL/CT_OuterShadowEffect.html +12 -19
- data/rdoc/RubyXL/CT_Path2D.html +12 -19
- data/rdoc/RubyXL/CT_Path2DArcTo.html +12 -19
- data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +12 -19
- data/rdoc/RubyXL/CT_Path2DList.html +12 -19
- data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +12 -19
- data/rdoc/RubyXL/CT_Path2DTo.html +12 -19
- data/rdoc/RubyXL/CT_PathShadeProperties.html +12 -19
- data/rdoc/RubyXL/CT_PatternFillProperties.html +12 -19
- data/rdoc/RubyXL/CT_Point3D.html +12 -19
- data/rdoc/RubyXL/CT_PolarAdjustHandle.html +12 -19
- data/rdoc/RubyXL/CT_PresetColor.html +12 -19
- data/rdoc/RubyXL/CT_PresetLineDashProperties.html +12 -19
- data/rdoc/RubyXL/CT_PresetShadowEffect.html +12 -19
- data/rdoc/RubyXL/CT_PresetTextShape.html +12 -19
- data/rdoc/RubyXL/CT_ReflectionEffect.html +12 -19
- data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +12 -19
- data/rdoc/RubyXL/CT_RelativeRect.html +12 -19
- data/rdoc/RubyXL/CT_SRgbColor.html +12 -19
- data/rdoc/RubyXL/CT_ScRgbColor.html +12 -19
- data/rdoc/RubyXL/CT_Scene3D.html +12 -19
- data/rdoc/RubyXL/CT_SchemeColor.html +12 -19
- data/rdoc/RubyXL/CT_Shape3D.html +12 -19
- data/rdoc/RubyXL/CT_ShapeStyle.html +12 -19
- data/rdoc/RubyXL/CT_SoftEdgesEffect.html +12 -19
- data/rdoc/RubyXL/CT_SphereCoords.html +12 -19
- data/rdoc/RubyXL/CT_StretchInfoProperties.html +12 -19
- data/rdoc/RubyXL/CT_StyleMatrix.html +12 -19
- data/rdoc/RubyXL/CT_StyleMatrixReference.html +12 -19
- data/rdoc/RubyXL/CT_SupplementalFont.html +12 -19
- data/rdoc/RubyXL/CT_SystemColor.html +12 -19
- data/rdoc/RubyXL/CT_TextAutonumberBullet.html +12 -19
- data/rdoc/RubyXL/CT_TextBlipBullet.html +12 -19
- data/rdoc/RubyXL/CT_TextCharBullet.html +12 -19
- data/rdoc/RubyXL/CT_TextCharacterProperties.html +12 -19
- data/rdoc/RubyXL/CT_TextFont.html +12 -19
- data/rdoc/RubyXL/CT_TextListStyle.html +12 -19
- data/rdoc/RubyXL/CT_TextNormalAutofit.html +12 -19
- data/rdoc/RubyXL/CT_TextParagraphProperties.html +12 -19
- data/rdoc/RubyXL/CT_TextSpacing.html +12 -19
- data/rdoc/RubyXL/CT_TextTabStop.html +12 -19
- data/rdoc/RubyXL/CT_TextTabStopList.html +12 -19
- data/rdoc/RubyXL/CT_TileInfoProperties.html +12 -19
- data/rdoc/RubyXL/CT_TintEffect.html +12 -19
- data/rdoc/RubyXL/CT_Transform2D.html +12 -19
- data/rdoc/RubyXL/CT_TransformEffect.html +12 -19
- data/rdoc/RubyXL/CT_Vector3D.html +12 -19
- data/rdoc/RubyXL/CT_XYAdjustHandle.html +12 -19
- data/rdoc/RubyXL/CalculationChain.html +16 -45
- data/rdoc/RubyXL/CalculationChainCell.html +12 -19
- data/rdoc/RubyXL/CalculationProperties.html +12 -19
- data/rdoc/RubyXL/Cell.html +133 -209
- data/rdoc/RubyXL/CellConvenienceMethods.html +168 -522
- data/rdoc/RubyXL/CellExt.html +12 -19
- data/rdoc/RubyXL/CellSmartTag.html +12 -19
- data/rdoc/RubyXL/CellSmartTagProperty.html +12 -19
- data/rdoc/RubyXL/CellSmartTags.html +12 -19
- data/rdoc/RubyXL/CellStyle.html +12 -19
- data/rdoc/RubyXL/CellStyleXFs.html +18 -39
- data/rdoc/RubyXL/CellStyles.html +18 -39
- data/rdoc/RubyXL/CellValue.html +17 -38
- data/rdoc/RubyXL/CellWatch.html +12 -19
- data/rdoc/RubyXL/CellWatches.html +12 -19
- data/rdoc/RubyXL/CellXFs.html +19 -42
- data/rdoc/RubyXL/ChartColorsFile.html +11 -25
- data/rdoc/RubyXL/ChartFile.html +18 -49
- data/rdoc/RubyXL/ChartStyleFile.html +11 -25
- data/rdoc/RubyXL/ChartUserShapesFile.html +11 -25
- data/rdoc/RubyXL/Chartsheet.html +19 -68
- data/rdoc/RubyXL/ChartsheetPageSetup.html +12 -19
- data/rdoc/RubyXL/ChartsheetProperties.html +12 -19
- data/rdoc/RubyXL/ChartsheetProtection.html +12 -19
- data/rdoc/RubyXL/ChartsheetView.html +12 -19
- data/rdoc/RubyXL/ChartsheetViews.html +12 -19
- data/rdoc/RubyXL/Color.html +18 -55
- data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +18 -65
- data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +28 -88
- data/rdoc/RubyXL/ColorConvenienceClasses.html +9 -14
- data/rdoc/RubyXL/ColorConvenienceMethods.html +14 -33
- data/rdoc/RubyXL/ColorFilter.html +12 -19
- data/rdoc/RubyXL/ColorScale.html +12 -19
- data/rdoc/RubyXL/ColorSet.html +12 -19
- data/rdoc/RubyXL/Colors.html +12 -19
- data/rdoc/RubyXL/ColumnRange.html +22 -74
- data/rdoc/RubyXL/ColumnRanges.html +23 -83
- data/rdoc/RubyXL/Comment.html +12 -19
- data/rdoc/RubyXL/CommentList.html +12 -19
- data/rdoc/RubyXL/CommentsFile.html +17 -51
- data/rdoc/RubyXL/ConditionalFormatValue.html +12 -19
- data/rdoc/RubyXL/ConditionalFormatting.html +12 -19
- data/rdoc/RubyXL/ConditionalFormattingRule.html +12 -19
- data/rdoc/RubyXL/Connection.html +99 -0
- data/rdoc/RubyXL/ConnectionTable.html +99 -0
- data/rdoc/RubyXL/ConnectionTables.html +99 -0
- data/rdoc/RubyXL/ConnectionTextField.html +99 -0
- data/rdoc/RubyXL/ConnectionTextFields.html +99 -0
- data/rdoc/RubyXL/Connections.html +147 -0
- data/rdoc/RubyXL/ContentTypeDefault.html +11 -17
- data/rdoc/RubyXL/ContentTypeOverride.html +11 -17
- data/rdoc/RubyXL/ContentTypes.html +22 -63
- data/rdoc/RubyXL/ControlPropertiesFile.html +13 -22
- data/rdoc/RubyXL/CorePropertiesFile.html +34 -171
- data/rdoc/RubyXL/CustomColor.html +12 -19
- data/rdoc/RubyXL/CustomColorList.html +12 -19
- data/rdoc/RubyXL/CustomFilter.html +12 -19
- data/rdoc/RubyXL/CustomFilters.html +12 -19
- data/rdoc/RubyXL/CustomGeometry.html +12 -19
- data/rdoc/RubyXL/CustomProperties.html +12 -19
- data/rdoc/RubyXL/CustomPropertiesFile.html +11 -25
- data/rdoc/RubyXL/CustomProperty.html +12 -19
- data/rdoc/RubyXL/CustomPropertyFile.html +11 -25
- data/rdoc/RubyXL/CustomSheetView.html +12 -19
- data/rdoc/RubyXL/CustomSheetViews.html +12 -19
- data/rdoc/RubyXL/CustomWorkbookView.html +12 -19
- data/rdoc/RubyXL/CustomWorkbookViews.html +12 -19
- data/rdoc/RubyXL/CustomXMLFile.html +11 -22
- data/rdoc/RubyXL/DXF.html +12 -19
- data/rdoc/RubyXL/DXFs.html +12 -19
- data/rdoc/RubyXL/DataBar.html +12 -19
- data/rdoc/RubyXL/DataConsolidate.html +12 -19
- data/rdoc/RubyXL/DataConsolidationReference.html +12 -19
- data/rdoc/RubyXL/DataConsolidationReferences.html +12 -19
- data/rdoc/RubyXL/DataType.html +10 -39
- data/rdoc/RubyXL/DataValidation.html +12 -19
- data/rdoc/RubyXL/DataValidations.html +12 -19
- data/rdoc/RubyXL/DateGroupItem.html +12 -19
- data/rdoc/RubyXL/DefinedName.html +12 -19
- data/rdoc/RubyXL/DefinedNameExt.html +12 -19
- data/rdoc/RubyXL/DefinedNames.html +12 -19
- data/rdoc/RubyXL/DefinedNamesExt.html +12 -19
- data/rdoc/RubyXL/DocumentPropertiesFile.html +21 -68
- data/rdoc/RubyXL/DrawingFile.html +18 -49
- data/rdoc/RubyXL/DynamicFilter.html +12 -19
- data/rdoc/RubyXL/EmbeddedControl.html +12 -19
- data/rdoc/RubyXL/EmbeddedControls.html +12 -19
- data/rdoc/RubyXL/Extension.html +12 -19
- data/rdoc/RubyXL/ExtensionStorageArea.html +12 -19
- data/rdoc/RubyXL/Extents.html +12 -19
- data/rdoc/RubyXL/ExternalBook.html +12 -19
- data/rdoc/RubyXL/ExternalLinksFile.html +18 -49
- data/rdoc/RubyXL/ExternalReference.html +12 -19
- data/rdoc/RubyXL/ExternalReferences.html +12 -19
- data/rdoc/RubyXL/ExtraColorSchemeList.html +12 -19
- data/rdoc/RubyXL/FieldItem.html +12 -19
- data/rdoc/RubyXL/FileRecoveryProperties.html +12 -19
- data/rdoc/RubyXL/FileSharing.html +12 -19
- data/rdoc/RubyXL/FileVersion.html +12 -19
- data/rdoc/RubyXL/Fill.html +18 -39
- data/rdoc/RubyXL/Fills.html +18 -39
- data/rdoc/RubyXL/FilterContainer.html +12 -19
- data/rdoc/RubyXL/FloatNode.html +11 -17
- data/rdoc/RubyXL/FloatValue.html +11 -17
- data/rdoc/RubyXL/Font.html +21 -59
- data/rdoc/RubyXL/FontConvenienceMethods.html +48 -237
- data/rdoc/RubyXL/FontScheme.html +12 -19
- data/rdoc/RubyXL/Fonts.html +18 -39
- data/rdoc/RubyXL/Formula.html +12 -19
- data/rdoc/RubyXL/FunctionGroup.html +12 -19
- data/rdoc/RubyXL/FunctionGroups.html +12 -19
- data/rdoc/RubyXL/GenericStorageObject.html +21 -84
- data/rdoc/RubyXL/GradientFill.html +12 -19
- data/rdoc/RubyXL/HeaderFooterSettings.html +12 -19
- data/rdoc/RubyXL/Hyperlink.html +12 -19
- data/rdoc/RubyXL/HyperlinkRelFile.html +11 -22
- data/rdoc/RubyXL/Hyperlinks.html +12 -19
- data/rdoc/RubyXL/IconFilter.html +12 -19
- data/rdoc/RubyXL/IconSet.html +12 -19
- data/rdoc/RubyXL/IgnoredError.html +12 -19
- data/rdoc/RubyXL/IgnoredErrors.html +12 -19
- data/rdoc/RubyXL/IndexedColors.html +12 -19
- data/rdoc/RubyXL/InputCells.html +12 -19
- data/rdoc/RubyXL/IntegerNode.html +11 -17
- data/rdoc/RubyXL/IntegerValue.html +11 -17
- data/rdoc/RubyXL/LegacyCell.html +13 -66
- data/rdoc/RubyXL/LegacyWorksheet.html +25 -99
- data/rdoc/RubyXL/MRUColors.html +12 -19
- data/rdoc/RubyXL/MacrosFile.html +11 -25
- data/rdoc/RubyXL/MergedCell.html +12 -19
- data/rdoc/RubyXL/MergedCells.html +12 -19
- data/rdoc/RubyXL/NumFmt.html +12 -19
- data/rdoc/RubyXL/NumberFormat.html +18 -39
- data/rdoc/RubyXL/NumberFormats.html +18 -45
- data/rdoc/RubyXL/OLEObject.html +12 -19
- data/rdoc/RubyXL/OLEObjectFile.html +11 -25
- data/rdoc/RubyXL/OLEObjects.html +12 -19
- data/rdoc/RubyXL/OLESize.html +12 -19
- data/rdoc/RubyXL/OOXMLContainerObject.html +35 -132
- data/rdoc/RubyXL/OOXMLIgnored.html +19 -53
- data/rdoc/RubyXL/OOXMLObject.html +14 -25
- data/rdoc/RubyXL/OOXMLObjectClassMethods.html +91 -183
- data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +48 -185
- data/rdoc/RubyXL/OOXMLRelationshipsFile.html +47 -200
- data/rdoc/RubyXL/OOXMLTopLevelObject.html +36 -133
- data/rdoc/RubyXL/OdbcOleDbProperties.html +99 -0
- data/rdoc/RubyXL/Offset.html +12 -19
- data/rdoc/RubyXL/OlapProperties.html +99 -0
- data/rdoc/RubyXL/OleItem.html +99 -0
- data/rdoc/RubyXL/OleItems.html +99 -0
- data/rdoc/RubyXL/OleLink.html +99 -0
- data/rdoc/RubyXL/OutlineProperties.html +12 -19
- data/rdoc/RubyXL/PageMargins.html +12 -19
- data/rdoc/RubyXL/PageSetup.html +12 -19
- data/rdoc/RubyXL/PageSetupProperties.html +12 -19
- data/rdoc/RubyXL/Pane.html +12 -19
- data/rdoc/RubyXL/Parser.html +22 -56
- data/rdoc/RubyXL/PatternFill.html +12 -19
- data/rdoc/RubyXL/PhoneticProperties.html +12 -19
- data/rdoc/RubyXL/PhoneticRun.html +12 -19
- data/rdoc/RubyXL/PivotArea.html +12 -19
- data/rdoc/RubyXL/PivotCache.html +12 -19
- data/rdoc/RubyXL/PivotCacheDefinitionFile.html +13 -30
- data/rdoc/RubyXL/PivotCacheRecordsFile.html +11 -25
- data/rdoc/RubyXL/PivotCaches.html +12 -19
- data/rdoc/RubyXL/PivotReference.html +12 -19
- data/rdoc/RubyXL/PivotReferences.html +12 -19
- data/rdoc/RubyXL/PivotTableFile.html +13 -30
- data/rdoc/RubyXL/PivotTableSelection.html +12 -19
- data/rdoc/RubyXL/PresetGeometry.html +12 -19
- data/rdoc/RubyXL/PrintOptions.html +12 -19
- data/rdoc/RubyXL/PrinterSettingsFile.html +11 -25
- data/rdoc/RubyXL/ProtectedRange.html +12 -19
- data/rdoc/RubyXL/ProtectedRanges.html +12 -19
- data/rdoc/RubyXL/Protection.html +12 -19
- data/rdoc/RubyXL/QueryParameter.html +99 -0
- data/rdoc/RubyXL/QueryParameters.html +99 -0
- data/rdoc/RubyXL/QueryTable.html +155 -0
- data/rdoc/RubyXL/QueryTableDeletedField.html +99 -0
- data/rdoc/RubyXL/QueryTableDeletedFields.html +99 -0
- data/rdoc/RubyXL/QueryTableField.html +99 -0
- data/rdoc/RubyXL/QueryTableFields.html +99 -0
- data/rdoc/RubyXL/QueryTableRefresh.html +99 -0
- data/rdoc/RubyXL/RID.html +11 -17
- data/rdoc/RubyXL/RawOOXML.html +20 -60
- data/rdoc/RubyXL/Reference.html +62 -228
- data/rdoc/RubyXL/Relationship.html +11 -17
- data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +13 -32
- data/rdoc/RubyXL/RelationshipSupport.html +25 -120
- data/rdoc/RubyXL/RevisionPointer.html +12 -22
- data/rdoc/RubyXL/RichText.html +19 -39
- data/rdoc/RubyXL/RichTextRun.html +17 -38
- data/rdoc/RubyXL/Row.html +33 -168
- data/rdoc/RubyXL/RowExt.html +12 -19
- data/rdoc/RubyXL/RunProperties.html +12 -19
- data/rdoc/RubyXL/Scenario.html +12 -19
- data/rdoc/RubyXL/Scenarios.html +12 -19
- data/rdoc/RubyXL/Selection.html +16 -37
- data/rdoc/RubyXL/ShapeGuide.html +12 -19
- data/rdoc/RubyXL/ShapeTextRectangle.html +12 -19
- data/rdoc/RubyXL/SharedStringsTable.html +37 -147
- data/rdoc/RubyXL/Sheet.html +12 -19
- data/rdoc/RubyXL/SheetCalculationProperties.html +12 -19
- data/rdoc/RubyXL/SheetData.html +19 -53
- data/rdoc/RubyXL/SheetDataExt.html +12 -19
- data/rdoc/RubyXL/SheetDataSet.html +12 -19
- data/rdoc/RubyXL/SheetMetadata.html +108 -0
- data/rdoc/RubyXL/SheetName.html +12 -19
- data/rdoc/RubyXL/SheetNames.html +12 -19
- data/rdoc/RubyXL/Sheets.html +12 -19
- data/rdoc/RubyXL/SlicerCacheFile.html +11 -25
- data/rdoc/RubyXL/SlicerFile.html +11 -25
- data/rdoc/RubyXL/SmartTagProperties.html +12 -19
- data/rdoc/RubyXL/SmartTagType.html +12 -19
- data/rdoc/RubyXL/SmartTagTypes.html +12 -19
- data/rdoc/RubyXL/SmartTags.html +12 -19
- data/rdoc/RubyXL/SortCondition.html +12 -19
- data/rdoc/RubyXL/SortState.html +12 -19
- data/rdoc/RubyXL/Sqref.html +19 -53
- data/rdoc/RubyXL/Stop.html +12 -19
- data/rdoc/RubyXL/StringNode.html +11 -17
- data/rdoc/RubyXL/StringNodeW3C.html +20 -54
- data/rdoc/RubyXL/StringValue.html +11 -17
- data/rdoc/RubyXL/Stylesheet.html +34 -117
- data/rdoc/RubyXL/TableFile.html +11 -25
- data/rdoc/RubyXL/TableParts.html +11 -17
- data/rdoc/RubyXL/TableStyle.html +12 -19
- data/rdoc/RubyXL/TableStyles.html +12 -19
- data/rdoc/RubyXL/Text.html +22 -67
- data/rdoc/RubyXL/TextImportSettings.html +99 -0
- data/rdoc/RubyXL/Theme.html +19 -75
- data/rdoc/RubyXL/ThemeElements.html +12 -19
- data/rdoc/RubyXL/ThumbnailFile.html +11 -25
- data/rdoc/RubyXL/Top10.html +12 -19
- data/rdoc/RubyXL/VMLDrawingFile.html +14 -32
- data/rdoc/RubyXL/Variant.html +12 -19
- data/rdoc/RubyXL/Vector.html +17 -38
- data/rdoc/RubyXL/VectorValue.html +11 -17
- data/rdoc/RubyXL/VisualProperties.html +12 -19
- data/rdoc/RubyXL/WebPublishObject.html +12 -19
- data/rdoc/RubyXL/WebPublishObjects.html +12 -19
- data/rdoc/RubyXL/WebPublishingItem.html +12 -19
- data/rdoc/RubyXL/WebPublishingItems.html +12 -19
- data/rdoc/RubyXL/WebPublishingProperties.html +12 -19
- data/rdoc/RubyXL/WebQueryProperties.html +99 -0
- data/rdoc/RubyXL/Workbook.html +486 -227
- data/rdoc/RubyXL/WorkbookConvenienceMethods.html +130 -888
- data/rdoc/RubyXL/WorkbookProperties.html +12 -19
- data/rdoc/RubyXL/WorkbookProtection.html +12 -19
- data/rdoc/RubyXL/WorkbookRoot.html +27 -114
- data/rdoc/RubyXL/WorkbookView.html +12 -19
- data/rdoc/RubyXL/WorkbookViews.html +12 -19
- data/rdoc/RubyXL/Worksheet.html +92 -121
- data/rdoc/RubyXL/WorksheetConvenienceMethods.html +298 -1109
- data/rdoc/RubyXL/WorksheetDimensions.html +12 -19
- data/rdoc/RubyXL/WorksheetFormatProperties.html +11 -17
- data/rdoc/RubyXL/WorksheetProperties.html +12 -19
- data/rdoc/RubyXL/WorksheetProtection.html +12 -19
- data/rdoc/RubyXL/WorksheetView.html +12 -19
- data/rdoc/RubyXL/WorksheetViews.html +12 -19
- data/rdoc/RubyXL/XF.html +12 -19
- data/rdoc/RubyXL.html +39 -318
- data/rdoc/created.rid +45 -38
- data/rdoc/css/rdoc.css +55 -6
- data/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/rdoc/index.html +33 -373
- data/rdoc/js/darkfish.js +22 -99
- data/rdoc/js/navigation.js +4 -41
- data/rdoc/js/navigation.js.gz +0 -0
- data/rdoc/js/search.js +32 -31
- data/rdoc/js/search_index.js +1 -1
- data/rdoc/js/search_index.js.gz +0 -0
- data/rdoc/js/searcher.js +6 -6
- data/rdoc/js/searcher.js.gz +0 -0
- data/rdoc/table_of_contents.html +205 -45
- data/rubyXL.gemspec +53 -29
- data/spec/lib/cell_spec.rb +57 -6
- data/spec/lib/color_spec.rb +2 -1
- data/spec/lib/parser_spec.rb +24 -27
- data/spec/lib/reference_spec.rb +9 -3
- data/spec/lib/rgb_color_spec.rb +27 -0
- data/spec/lib/stylesheet_spec.rb +8 -11
- data/spec/lib/text_spec.rb +1 -5
- data/spec/lib/workbook_spec.rb +25 -4
- data/spec/lib/worksheet_spec.rb +873 -479
- data/spec/spec_helper.rb +2 -0
- data/test/test_parse_write.rb +15 -15
- metadata +54 -10
- data/rdoc/js/jquery.js +0 -4
|
@@ -4,21 +4,23 @@
|
|
|
4
4
|
<head>
|
|
5
5
|
<meta charset="UTF-8">
|
|
6
6
|
|
|
7
|
-
<title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.
|
|
7
|
+
<title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.4.25</title>
|
|
8
8
|
|
|
9
9
|
<script type="text/javascript">
|
|
10
10
|
var rdoc_rel_prefix = "../";
|
|
11
11
|
var index_rel_prefix = "../";
|
|
12
12
|
</script>
|
|
13
13
|
|
|
14
|
-
<script src="../js/
|
|
15
|
-
<script src="../js/
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
16
19
|
|
|
17
20
|
<link href="../css/fonts.css" rel="stylesheet">
|
|
18
21
|
<link href="../css/rdoc.css" rel="stylesheet">
|
|
19
22
|
|
|
20
23
|
|
|
21
|
-
|
|
22
24
|
<body id="top" role="document" class="module">
|
|
23
25
|
<nav role="navigation">
|
|
24
26
|
<div id="project-navigation">
|
|
@@ -58,22 +60,18 @@
|
|
|
58
60
|
|
|
59
61
|
|
|
60
62
|
|
|
61
|
-
|
|
63
|
+
|
|
64
|
+
<!-- Method Quickref -->
|
|
62
65
|
<div id="method-list-section" class="nav-section">
|
|
63
66
|
<h3>Methods</h3>
|
|
64
67
|
|
|
65
68
|
<ul class="link-list" role="directory">
|
|
66
|
-
|
|
67
69
|
<li ><a href="#method-i-define_attribute">#define_attribute</a>
|
|
68
|
-
|
|
69
70
|
<li ><a href="#method-i-define_child_node">#define_child_node</a>
|
|
70
|
-
|
|
71
71
|
<li ><a href="#method-i-define_element_name">#define_element_name</a>
|
|
72
|
-
|
|
72
|
+
<li ><a href="#method-i-define_relationship">#define_relationship</a>
|
|
73
73
|
<li ><a href="#method-i-obtain_class_variable">#obtain_class_variable</a>
|
|
74
|
-
|
|
75
74
|
<li ><a href="#method-i-parse">#parse</a>
|
|
76
|
-
|
|
77
75
|
</ul>
|
|
78
76
|
</div>
|
|
79
77
|
|
|
@@ -89,52 +87,35 @@
|
|
|
89
87
|
|
|
90
88
|
</section>
|
|
91
89
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
90
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
96
|
-
|
|
97
91
|
|
|
98
|
-
|
|
99
92
|
|
|
100
|
-
|
|
101
93
|
|
|
102
|
-
|
|
103
94
|
|
|
104
|
-
|
|
95
|
+
|
|
105
96
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
106
97
|
<header>
|
|
107
98
|
<h3>Public Instance Methods</h3>
|
|
108
99
|
</header>
|
|
109
100
|
|
|
110
|
-
|
|
111
101
|
<div id="method-i-define_attribute" class="method-detail ">
|
|
112
|
-
|
|
113
102
|
<div class="method-heading">
|
|
114
103
|
<span class="method-name">define_attribute</span><span
|
|
115
|
-
class="method-args">(attr_name, attr_type, extra_params =
|
|
116
|
-
|
|
104
|
+
class="method-args">(attr_name, attr_type, extra_params = nil)</span>
|
|
117
105
|
<span class="method-click-advice">click to toggle source</span>
|
|
118
|
-
|
|
119
106
|
</div>
|
|
120
|
-
|
|
121
107
|
|
|
122
108
|
<div class="method-description">
|
|
123
|
-
|
|
124
109
|
<p>Defines an attribute of OOXML object.</p>
|
|
125
110
|
|
|
126
111
|
<h3 id="method-i-define_attribute-label-Parameters">Parameters<span><a href="#method-i-define_attribute-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
|
127
112
|
<ul><li>
|
|
128
|
-
<p><code>attribute_name</code> - Name of the element attribute as seen in the
|
|
129
|
-
source XML. Can be either <code>"String"</code> or
|
|
130
|
-
<code>:Symbol</code></p>
|
|
113
|
+
<p><code>attribute_name</code> - Name of the element attribute as seen in the source XML. Can be either <code>"String"</code> or <code>:Symbol</code></p>
|
|
131
114
|
<ul><li>
|
|
132
|
-
<p>Special attibute name <code>'_'</code> (underscore) denotes the
|
|
133
|
-
value of the element rather than attribute.</p>
|
|
115
|
+
<p>Special attibute name <code>'_'</code> (underscore) denotes the value of the element rather than attribute.</p>
|
|
134
116
|
</li></ul>
|
|
135
117
|
</li><li>
|
|
136
|
-
<p><code>attribute_type</code> - Specifies the conversion type for the
|
|
137
|
-
attribute when parsing. Available options are:</p>
|
|
118
|
+
<p><code>attribute_type</code> - Specifies the conversion type for the attribute when parsing. Available options are:</p>
|
|
138
119
|
<ul><li>
|
|
139
120
|
<p><code>:int</code> - <code>Integer</code></p>
|
|
140
121
|
</li><li>
|
|
@@ -144,129 +125,92 @@ attribute when parsing. Available options are:</p>
|
|
|
144
125
|
</li><li>
|
|
145
126
|
<p><code>:string</code> - <code>String</code> (no conversion)</p>
|
|
146
127
|
</li><li>
|
|
147
|
-
<p><code>:sqref</code> - <a href="Sqref.html">RubyXL::Sqref</a></p>
|
|
128
|
+
<p><code>:sqref</code> - <a href="Sqref.html"><code>RubyXL::Sqref</code></a></p>
|
|
148
129
|
</li><li>
|
|
149
|
-
<p><code>:ref</code> - <a href="Reference.html">RubyXL::Reference</a></p>
|
|
130
|
+
<p><code>:ref</code> - <a href="Reference.html"><code>RubyXL::Reference</code></a></p>
|
|
150
131
|
</li><li>
|
|
151
|
-
<p><code>:bool</code> - <code>Boolean</code> (“1” and “true” convert to
|
|
152
|
-
<code>true</code>, others to <code>false</code>)</p>
|
|
132
|
+
<p><code>:bool</code> - <code>Boolean</code> (“1” and “true” convert to <code>true</code>, others to <code>false</code>)</p>
|
|
153
133
|
</li><li>
|
|
154
|
-
<p>one of <code>simple_types</code> - <code>String</code>, plus the list of
|
|
155
|
-
acceptable values is saved for future validation (not used yet).</p>
|
|
134
|
+
<p>one of <code>simple_types</code> - <code>String</code>, plus the list of acceptable values is saved for future validation (not used yet).</p>
|
|
156
135
|
</li></ul>
|
|
157
136
|
</li><li>
|
|
158
137
|
<p><code>extra_parameters</code> - Hash of optional parameters as follows:</p>
|
|
159
138
|
<ul><li>
|
|
160
|
-
<p><code>:accessor</code> - Name of the accessor for this attribute to be
|
|
161
|
-
defined on the object. If not provided, defaults to classidied
|
|
162
|
-
<code>attribute_name</code>.</p>
|
|
139
|
+
<p><code>:accessor</code> - Name of the accessor for this attribute to be defined on the object. If not provided, defaults to classidied <code>attribute_name</code>.</p>
|
|
163
140
|
</li><li>
|
|
164
|
-
<p><code>:default</code> - Value this attribute defaults to if not explicitly
|
|
165
|
-
provided.</p>
|
|
141
|
+
<p><code>:default</code> - Value this attribute defaults to if not explicitly provided.</p>
|
|
166
142
|
</li><li>
|
|
167
|
-
<p><code>:required</code> - Whether this attribute is required when writing
|
|
168
|
-
XML. If the value of the attrinute is not explicitly provided,
|
|
169
|
-
<code>:default</code> is written instead.</p>
|
|
143
|
+
<p><code>:required</code> - Whether this attribute is required when writing XML. If the value of the attrinute is not explicitly provided, <code>:default</code> is written instead.</p>
|
|
170
144
|
</li><li>
|
|
171
|
-
<p><code>:computed</code> - Do not store this attribute on <code>parse</code>,
|
|
172
|
-
but do call the object-provided read accessor on <code>write_xml</code>.</p>
|
|
145
|
+
<p><code>:computed</code> - Do not store this attribute on <code>parse</code>, but do call the object-provided read accessor on <code>write_xml</code>.</p>
|
|
173
146
|
</li></ul>
|
|
174
147
|
</li></ul>
|
|
175
148
|
|
|
176
149
|
<h4 id="method-i-define_attribute-label-Examples">Examples<span><a href="#method-i-define_attribute-label-Examples">¶</a> <a href="#top">↑</a></span></h4>
|
|
177
150
|
|
|
178
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
|
151
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:outline</span>, <span class="ruby-value">:bool</span>, <span class="ruby-value">:default</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>)
|
|
179
152
|
</pre>
|
|
180
153
|
|
|
181
|
-
<p>A <code>Boolean</code> attribute
|
|
182
|
-
<code>true</code> will be accessible by calling <code>obj.outline</code></p>
|
|
154
|
+
<p>A <code>Boolean</code> attribute ‘outline’ with default value <code>true</code> will be accessible by calling <code>obj.outline</code></p>
|
|
183
155
|
|
|
184
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
|
156
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:uniqueCount</span>, <span class="ruby-value">:int</span>)
|
|
185
157
|
</pre>
|
|
186
158
|
|
|
187
|
-
<p>An <code>Integer</code> attribute
|
|
188
|
-
<code>obj.unique_count</code></p>
|
|
159
|
+
<p>An <code>Integer</code> attribute ‘uniqueCount’ accessible as <code>obj.unique_count</code></p>
|
|
189
160
|
|
|
190
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
|
161
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:_</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-value">:expression</span>)
|
|
191
162
|
</pre>
|
|
192
163
|
|
|
193
|
-
<p>The value of the element will be accessible as a <code>String</code> by
|
|
194
|
-
calling <code>obj.expression</code></p>
|
|
164
|
+
<p>The value of the element will be accessible as a <code>String</code> by calling <code>obj.expression</code></p>
|
|
195
165
|
|
|
196
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
|
166
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:errorStyle</span>, <span class="ruby-node">%w{ stop warning information }</span>, <span class="ruby-value">:default</span> <span class="ruby-operator">=></span> <span class="ruby-string">'stop'</span>,)
|
|
197
167
|
</pre>
|
|
198
168
|
|
|
199
|
-
<p>A <code>String</code> attribute named
|
|
200
|
-
accessible as <code>obj.error_style</code>, valid values are
|
|
201
|
-
<code>"stop"</code>, <code>"warning"</code>,
|
|
202
|
-
<code>"information"</code></p>
|
|
203
|
-
|
|
204
|
-
|
|
169
|
+
<p>A <code>String</code> attribute named ‘errorStyle’ will be accessible as <code>obj.error_style</code>, valid values are <code>"stop"</code>, <code>"warning"</code>, <code>"information"</code></p>
|
|
205
170
|
|
|
206
|
-
|
|
207
171
|
<div class="method-source-code" id="define_attribute-source">
|
|
208
172
|
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 48</span>
|
|
209
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_attribute</span>(<span class="ruby-identifier">attr_name</span>, <span class="ruby-identifier">attr_type</span>, <span class="ruby-identifier">extra_params</span> =
|
|
173
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_attribute</span>(<span class="ruby-identifier">attr_name</span>, <span class="ruby-identifier">attr_type</span>, <span class="ruby-identifier">extra_params</span> = <span class="ruby-keyword">nil</span>)
|
|
210
174
|
<span class="ruby-identifier">attrs</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>)
|
|
211
|
-
<span class="ruby-identifier">attr_hash</span> =
|
|
175
|
+
<span class="ruby-identifier">attr_hash</span> = { <span class="ruby-value">:attr_type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">attr_type</span> }
|
|
176
|
+
<span class="ruby-identifier">attr_hash</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">extra_params</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>
|
|
212
177
|
<span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">attr_name</span>)
|
|
213
178
|
<span class="ruby-identifier">attrs</span>[<span class="ruby-identifier">attr_name</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">attr_hash</span>
|
|
214
179
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:computed</span>]
|
|
215
180
|
<span class="ruby-keyword">end</span></pre>
|
|
216
181
|
</div>
|
|
217
|
-
|
|
218
182
|
</div>
|
|
219
183
|
|
|
220
|
-
|
|
221
184
|
|
|
222
|
-
|
|
223
185
|
</div>
|
|
224
186
|
|
|
225
|
-
|
|
226
187
|
<div id="method-i-define_child_node" class="method-detail ">
|
|
227
|
-
|
|
228
188
|
<div class="method-heading">
|
|
229
189
|
<span class="method-name">define_child_node</span><span
|
|
230
190
|
class="method-args">(klass, extra_params = {})</span>
|
|
231
|
-
|
|
232
191
|
<span class="method-click-advice">click to toggle source</span>
|
|
233
|
-
|
|
234
192
|
</div>
|
|
235
|
-
|
|
236
193
|
|
|
237
194
|
<div class="method-description">
|
|
238
|
-
|
|
239
195
|
<p>Defines a child node of OOXML object.</p>
|
|
240
196
|
|
|
241
197
|
<h3 id="method-i-define_child_node-label-Parameters">Parameters<span><a href="#method-i-define_child_node-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
|
242
198
|
<ul><li>
|
|
243
|
-
<p><code>klass</code> - Class (descendant of <a
|
|
244
|
-
href="OOXMLObject.html">RubyXL::OOXMLObject</a>) of the child nodes. Child
|
|
245
|
-
node objects will be produced by calling <code>parse</code> method of that
|
|
246
|
-
class.</p>
|
|
199
|
+
<p><code>klass</code> - Class (descendant of <a href="OOXMLObject.html"><code>RubyXL::OOXMLObject</code></a>) of the child nodes. Child node objects will be produced by calling <code>parse</code> method of that class.</p>
|
|
247
200
|
</li><li>
|
|
248
201
|
<p><code>extra_parameters</code> - Hash of optional parameters as follows:</p>
|
|
249
202
|
<ul><li>
|
|
250
|
-
<p><code>:accessor</code> - Name of the accessor for this attribute to be
|
|
251
|
-
defined on the object. If not provided, defaults to classidied
|
|
252
|
-
<code>attribute_name</code>.</p>
|
|
203
|
+
<p><code>:accessor</code> - Name of the accessor for this attribute to be defined on the object. If not provided, defaults to classidied <code>attribute_name</code>.</p>
|
|
253
204
|
</li><li>
|
|
254
|
-
<p><code>:node_name</code> - Node name for the child node, in case it does not
|
|
255
|
-
match the one defined by the <code>klass</code>.</p>
|
|
205
|
+
<p><code>:node_name</code> - Node name for the child node, in case it does not match the one defined by the <code>klass</code>.</p>
|
|
256
206
|
</li><li>
|
|
257
|
-
<p><code>:collection</code> - Whether the child node should be treated as a
|
|
258
|
-
single node or a collection of nodes:</p>
|
|
207
|
+
<p><code>:collection</code> - Whether the child node should be treated as a single node or a collection of nodes:</p>
|
|
259
208
|
<ul><li>
|
|
260
|
-
<p><code>false</code> (default) - child node is directly accessible through
|
|
261
|
-
the respective accessor;</p>
|
|
209
|
+
<p><code>false</code> (default) - child node is directly accessible through the respective accessor;</p>
|
|
262
210
|
</li><li>
|
|
263
|
-
<p><code>true</code> - a collection of child nodes is accessed as
|
|
264
|
-
<code>Array</code> through the respective accessor;</p>
|
|
211
|
+
<p><code>true</code> - a collection of child nodes is accessed as <code>Array</code> through the respective accessor;</p>
|
|
265
212
|
</li><li>
|
|
266
|
-
<p><code>:with_count</code> - same as <code>true</code>, but in addition, the
|
|
267
|
-
attribute <code>count</code> is defined on the current object, that will be
|
|
268
|
-
automatically set to the number of elements in the collection at the start
|
|
269
|
-
of <code>write_xml</code> call.</p>
|
|
213
|
+
<p><code>:with_count</code> - same as <code>true</code>, but in addition, the attribute <code>count</code> is defined on the current object, that will be automatically set to the number of elements in the collection at the start of <code>write_xml</code> call.</p>
|
|
270
214
|
</li></ul>
|
|
271
215
|
</li></ul>
|
|
272
216
|
</li></ul>
|
|
@@ -276,43 +220,35 @@ of <code>write_xml</code> call.</p>
|
|
|
276
220
|
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Alignment</span>)
|
|
277
221
|
</pre>
|
|
278
222
|
|
|
279
|
-
<p>Define a singular child node parsed by the RubyXL::BorderEdge.parse() and
|
|
280
|
-
accessed by the default <code>obj.alignment</code> accessor</p>
|
|
223
|
+
<p>Define a singular child node parsed by the RubyXL::BorderEdge.parse() and accessed by the default <code>obj.alignment</code> accessor</p>
|
|
281
224
|
|
|
282
|
-
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Hyperlink</span>,
|
|
225
|
+
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Hyperlink</span>, <span class="ruby-value">:collection</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-value">:hyperlinks</span>)
|
|
283
226
|
</pre>
|
|
284
227
|
|
|
285
|
-
<p>Define an array of nodes accessed by <code>obj.hyperlinks</code> accessor,
|
|
286
|
-
each of which will be parsed by the RubyXL::Hyperlink.parse()</p>
|
|
228
|
+
<p>Define an array of nodes accessed by <code>obj.hyperlinks</code> accessor, each of which will be parsed by the RubyXL::Hyperlink.parse()</p>
|
|
287
229
|
|
|
288
|
-
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>,
|
|
289
|
-
<span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>,
|
|
230
|
+
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>, <span class="ruby-value">:node_name</span> <span class="ruby-operator">=></span> <span class="ruby-value">:left</span>)
|
|
231
|
+
<span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>, <span class="ruby-value">:node_name</span> <span class="ruby-operator">=></span> <span class="ruby-value">:right</span>)
|
|
290
232
|
</pre>
|
|
291
233
|
|
|
292
|
-
<p>Use class <a href="BorderEdge.html">RubyXL::BorderEdge</a> when parsing
|
|
293
|
-
both the elements <code><left ...></code> and <code><right
|
|
294
|
-
...></code> elements.</p>
|
|
234
|
+
<p>Use class <a href="BorderEdge.html"><code>RubyXL::BorderEdge</code></a> when parsing both the elements <code><left ...></code> and <code><right ...></code> elements.</p>
|
|
295
235
|
|
|
296
|
-
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Font</span>,
|
|
236
|
+
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Font</span>, <span class="ruby-value">:collection</span> <span class="ruby-operator">=></span> <span class="ruby-value">:with_count</span>, <span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-value">:fonts</span>)
|
|
297
237
|
</pre>
|
|
298
238
|
|
|
299
|
-
<p>Upon writing of the object this was defined on, its <code>count</code>
|
|
300
|
-
attribute will be set to the count of nodes in <code>fonts</code> array</p>
|
|
301
|
-
|
|
302
|
-
|
|
239
|
+
<p>Upon writing of the object this was defined on, its <code>count</code> attribute will be set to the count of nodes in <code>fonts</code> array</p>
|
|
303
240
|
|
|
304
|
-
|
|
305
241
|
<div class="method-source-code" id="define_child_node-source">
|
|
306
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
307
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_child_node</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">extra_params</span> = {})
|
|
242
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 82</span>
|
|
243
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_child_node</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">extra_params</span> = {})
|
|
308
244
|
<span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
|
|
309
245
|
<span class="ruby-identifier">child_node_name</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:node_name</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-value">:@@ooxml_tag_name</span>)).<span class="ruby-identifier">to_s</span>
|
|
310
246
|
<span class="ruby-identifier">accessor</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">child_node_name</span>)).<span class="ruby-identifier">to_sym</span>
|
|
311
247
|
|
|
312
248
|
<span class="ruby-identifier">child_nodes</span>[<span class="ruby-identifier">child_node_name</span>] = {
|
|
313
|
-
<span class="ruby-value">:class</span>
|
|
314
|
-
<span class="ruby-value">:is_array</span>
|
|
315
|
-
<span class="ruby-value">:accessor</span>
|
|
249
|
+
<span class="ruby-value">:class</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">klass</span>,
|
|
250
|
+
<span class="ruby-value">:is_array</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>],
|
|
251
|
+
<span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">accessor</span>
|
|
316
252
|
}
|
|
317
253
|
|
|
318
254
|
<span class="ruby-identifier">define_count_attribute</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:with_count</span>
|
|
@@ -320,33 +256,20 @@ attribute will be set to the count of nodes in <code>fonts</code> array</p>
|
|
|
320
256
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">accessor</span>)
|
|
321
257
|
<span class="ruby-keyword">end</span></pre>
|
|
322
258
|
</div>
|
|
323
|
-
|
|
324
259
|
</div>
|
|
325
260
|
|
|
326
|
-
|
|
327
261
|
|
|
328
|
-
|
|
329
262
|
</div>
|
|
330
263
|
|
|
331
|
-
|
|
332
264
|
<div id="method-i-define_element_name" class="method-detail ">
|
|
333
|
-
|
|
334
265
|
<div class="method-heading">
|
|
335
266
|
<span class="method-name">define_element_name</span><span
|
|
336
267
|
class="method-args">(element_name)</span>
|
|
337
|
-
|
|
338
268
|
<span class="method-click-advice">click to toggle source</span>
|
|
339
|
-
|
|
340
269
|
</div>
|
|
341
|
-
|
|
342
270
|
|
|
343
271
|
<div class="method-description">
|
|
344
|
-
|
|
345
|
-
<p>Defines the name of the element that represents the current OOXML object.
|
|
346
|
-
Should only be used once per object. In case of different objects
|
|
347
|
-
represented by the same class in different parts of OOXML tree,
|
|
348
|
-
<code>:node_name</code> extra parameter can be used to override the default
|
|
349
|
-
element name.</p>
|
|
272
|
+
<p>Defines the name of the element that represents the current OOXML object. Should only be used once per object. In case of different objects represented by the same class in different parts of OOXML tree, <code>:node_name</code> extra parameter can be used to override the default element name.</p>
|
|
350
273
|
|
|
351
274
|
<h3 id="method-i-define_element_name-label-Parameters">Parameters<span><a href="#method-i-define_element_name-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
|
352
275
|
<ul><li>
|
|
@@ -357,89 +280,77 @@ element name.</p>
|
|
|
357
280
|
|
|
358
281
|
<pre class="ruby"><span class="ruby-identifier">define_element_name</span> <span class="ruby-string">'externalReference'</span>
|
|
359
282
|
</pre>
|
|
360
|
-
|
|
361
|
-
|
|
362
283
|
|
|
363
|
-
|
|
364
284
|
<div class="method-source-code" id="define_element_name-source">
|
|
365
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
366
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_element_name</span>(<span class="ruby-identifier">element_name</span>)
|
|
285
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 110</span>
|
|
286
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_element_name</span>(<span class="ruby-identifier">element_name</span>)
|
|
367
287
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-value">:@@ooxml_tag_name</span>, <span class="ruby-identifier">element_name</span>)
|
|
368
288
|
<span class="ruby-keyword">end</span></pre>
|
|
369
289
|
</div>
|
|
370
|
-
|
|
371
290
|
</div>
|
|
372
291
|
|
|
373
|
-
|
|
374
292
|
|
|
375
|
-
|
|
376
293
|
</div>
|
|
377
294
|
|
|
378
|
-
|
|
295
|
+
<div id="method-i-define_relationship" class="method-detail ">
|
|
296
|
+
<div class="method-heading">
|
|
297
|
+
<span class="method-name">define_relationship</span><span
|
|
298
|
+
class="method-args">(extra_params = {})</span>
|
|
299
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
300
|
+
</div>
|
|
301
|
+
|
|
302
|
+
<div class="method-description">
|
|
303
|
+
<p>Defines a ‘r:id` attribute</p>
|
|
304
|
+
|
|
305
|
+
<div class="method-source-code" id="define_relationship-source">
|
|
306
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 58</span>
|
|
307
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_relationship</span>(<span class="ruby-identifier">extra_params</span> = {})
|
|
308
|
+
<span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:'r:id'</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">extra_params</span>)
|
|
309
|
+
<span class="ruby-keyword">end</span></pre>
|
|
310
|
+
</div>
|
|
311
|
+
</div>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
</div>
|
|
315
|
+
|
|
379
316
|
<div id="method-i-obtain_class_variable" class="method-detail ">
|
|
380
|
-
|
|
381
317
|
<div class="method-heading">
|
|
382
318
|
<span class="method-name">obtain_class_variable</span><span
|
|
383
|
-
class="method-args">(var_name, default =
|
|
384
|
-
|
|
319
|
+
class="method-args">(var_name, default = nil)</span>
|
|
385
320
|
<span class="method-click-advice">click to toggle source</span>
|
|
386
|
-
|
|
387
321
|
</div>
|
|
388
|
-
|
|
389
322
|
|
|
390
323
|
<div class="method-description">
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
not specified)</p>
|
|
395
|
-
|
|
396
|
-
<p>Throughout this class, we are setting class variables through explicit
|
|
397
|
-
method calls rather than by directly addressing the name of the variable
|
|
398
|
-
because of context issues: addressing variable by name creates it in the
|
|
399
|
-
context of defining class, while calling the setter/getter method addresses
|
|
400
|
-
it in the context of descendant class, which is what we need.</p>
|
|
401
|
-
|
|
402
|
-
|
|
324
|
+
<p>Get the value of a [sub]class variable if it exists, or create the respective variable with the passed-in <code>default</code> (or +{}+, if not specified)</p>
|
|
325
|
+
|
|
326
|
+
<p>Throughout this class, we are setting class variables through explicit method calls rather than by directly addressing the name of the variable because of context issues: addressing variable by name creates it in the context of defining class, while calling the setter/getter method addresses it in the context of descendant class, which is what we need.</p>
|
|
403
327
|
|
|
404
|
-
|
|
405
328
|
<div class="method-source-code" id="obtain_class_variable-source">
|
|
406
329
|
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 15</span>
|
|
407
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> =
|
|
330
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">obtain_class_variable</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> = <span class="ruby-keyword">nil</span>)
|
|
408
331
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-identifier">var_name</span>)
|
|
409
332
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NameError</span>
|
|
410
|
-
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span>)
|
|
333
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> <span class="ruby-operator">||</span> {})
|
|
411
334
|
<span class="ruby-keyword">end</span></pre>
|
|
412
335
|
</div>
|
|
413
|
-
|
|
414
336
|
</div>
|
|
415
337
|
|
|
416
|
-
|
|
417
338
|
|
|
418
|
-
|
|
419
339
|
</div>
|
|
420
340
|
|
|
421
|
-
|
|
422
341
|
<div id="method-i-parse" class="method-detail ">
|
|
423
|
-
|
|
424
342
|
<div class="method-heading">
|
|
425
343
|
<span class="method-name">parse</span><span
|
|
426
344
|
class="method-args">(node, known_namespaces = nil)</span>
|
|
427
|
-
|
|
428
345
|
<span class="method-click-advice">click to toggle source</span>
|
|
429
|
-
|
|
430
346
|
</div>
|
|
431
|
-
|
|
432
347
|
|
|
433
348
|
<div class="method-description">
|
|
434
349
|
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
350
|
|
|
439
|
-
|
|
440
351
|
<div class="method-source-code" id="parse-source">
|
|
441
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
442
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">known_namespaces</span> = <span class="ruby-keyword">nil</span>)
|
|
352
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 114</span>
|
|
353
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">known_namespaces</span> = <span class="ruby-keyword">nil</span>)
|
|
443
354
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">node</span>
|
|
444
355
|
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>, <span class="ruby-constant">IO</span>, <span class="ruby-constant">Zip</span><span class="ruby-operator">::</span><span class="ruby-constant">InputStream</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">node</span> = <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">node</span>)
|
|
445
356
|
<span class="ruby-keyword">end</span>
|
|
@@ -476,9 +387,10 @@ it in the context of descendant class, which is what we need.</p>
|
|
|
476
387
|
<span class="ruby-identifier">known_namespaces</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_namespaces</span>)
|
|
477
388
|
|
|
478
389
|
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">element_children</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child_node</span><span class="ruby-operator">|</span>
|
|
479
|
-
|
|
480
390
|
<span class="ruby-identifier">ns</span> = <span class="ruby-identifier">child_node</span>.<span class="ruby-identifier">namespace</span>
|
|
481
|
-
<span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">known_namespaces</span>
|
|
391
|
+
<span class="ruby-identifier">prefix</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">known_namespaces</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">ns</span>.<span class="ruby-identifier">href</span>) <span class="ruby-keyword">then</span> <span class="ruby-identifier">known_namespaces</span>[<span class="ruby-identifier">ns</span>.<span class="ruby-identifier">href</span>]
|
|
392
|
+
<span class="ruby-keyword">else</span> <span class="ruby-identifier">ns</span>.<span class="ruby-identifier">prefix</span>
|
|
393
|
+
<span class="ruby-keyword">end</span>
|
|
482
394
|
|
|
483
395
|
<span class="ruby-identifier">child_node_name</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">prefix</span>
|
|
484
396
|
<span class="ruby-keyword">when</span> <span class="ruby-string">''</span>, <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">child_node</span>.<span class="ruby-identifier">name</span>
|
|
@@ -509,24 +421,20 @@ it in the context of descendant class, which is what we need.</p>
|
|
|
509
421
|
<span class="ruby-identifier">obj</span>
|
|
510
422
|
<span class="ruby-keyword">end</span></pre>
|
|
511
423
|
</div>
|
|
512
|
-
|
|
513
424
|
</div>
|
|
514
425
|
|
|
515
|
-
|
|
516
426
|
|
|
517
|
-
|
|
518
427
|
</div>
|
|
519
428
|
|
|
520
|
-
|
|
521
429
|
</section>
|
|
522
|
-
|
|
430
|
+
|
|
523
431
|
</section>
|
|
524
432
|
</main>
|
|
525
433
|
|
|
526
434
|
|
|
527
435
|
<footer id="validator-badges" role="contentinfo">
|
|
528
|
-
<p><a href="
|
|
529
|
-
<p>Generated by <a href="https://
|
|
436
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
437
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
|
|
530
438
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
531
439
|
</footer>
|
|
532
440
|
|